/
TsiTest.java
406 lines (334 loc) · 14.9 KB
/
TsiTest.java
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
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
/*
* Copyright 2018 The gRPC Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.grpc.alts.internal;
import static com.google.common.truth.Truth.assertThat;
import static io.grpc.alts.internal.ByteBufTestUtils.getDirectBuffer;
import static java.nio.charset.StandardCharsets.UTF_8;
import static org.junit.Assert.fail;
import io.grpc.alts.internal.ByteBufTestUtils.RegisterRef;
import io.grpc.alts.internal.TsiFrameProtector.Consumer;
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.buffer.UnpooledByteBufAllocator;
import java.nio.Buffer;
import java.nio.ByteBuffer;
import java.security.GeneralSecurityException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.crypto.AEADBadTagException;
/** Utility class that provides tests for implementations of @{link TsiHandshaker}. */
public final class TsiTest {
private static final String DECRYPTION_FAILURE_RE = "Tag mismatch!|BAD_DECRYPT";
private TsiTest() {}
/** A @{code TsiHandshaker} pair for running tests. */
public static class Handshakers {
private final TsiHandshaker client;
private final TsiHandshaker server;
public Handshakers(TsiHandshaker client, TsiHandshaker server) {
this.client = client;
this.server = server;
}
public TsiHandshaker getClient() {
return client;
}
public TsiHandshaker getServer() {
return server;
}
}
private static final int DEFAULT_TRANSPORT_BUFFER_SIZE = 2048;
private static final UnpooledByteBufAllocator alloc = UnpooledByteBufAllocator.DEFAULT;
private static final String EXAMPLE_MESSAGE1 = "hello world";
private static final String EXAMPLE_MESSAGE2 = "oysteroystersoysterseateateat";
private static final int EXAMPLE_MESSAGE1_LEN = EXAMPLE_MESSAGE1.getBytes(UTF_8).length;
private static final int EXAMPLE_MESSAGE2_LEN = EXAMPLE_MESSAGE2.getBytes(UTF_8).length;
static int getDefaultTransportBufferSize() {
return DEFAULT_TRANSPORT_BUFFER_SIZE;
}
/**
* Performs a handshake between the client handshaker and server handshaker using a transport of
* length transportBufferSize.
*/
static void performHandshake(int transportBufferSize, Handshakers handshakers)
throws GeneralSecurityException {
TsiHandshaker clientHandshaker = handshakers.getClient();
TsiHandshaker serverHandshaker = handshakers.getServer();
byte[] transportBufferBytes = new byte[transportBufferSize];
ByteBuffer transportBuffer = ByteBuffer.wrap(transportBufferBytes);
((Buffer) transportBuffer).limit(0); // Start off with an empty buffer
while (clientHandshaker.isInProgress() || serverHandshaker.isInProgress()) {
for (TsiHandshaker handshaker : new TsiHandshaker[] {clientHandshaker, serverHandshaker}) {
if (handshaker.isInProgress()) {
// Process any bytes on the wire.
if (transportBuffer.hasRemaining()) {
handshaker.processBytesFromPeer(transportBuffer);
}
// Put new bytes on the wire, if needed.
if (handshaker.isInProgress()) {
((Buffer) transportBuffer).clear();
handshaker.getBytesToSendToPeer(transportBuffer);
((Buffer) transportBuffer).flip();
}
}
}
}
clientHandshaker.extractPeer();
serverHandshaker.extractPeer();
}
public static void handshakeTest(Handshakers handshakers) throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
}
public static void handshakeSmallBufferTest(Handshakers handshakers)
throws GeneralSecurityException {
performHandshake(9, handshakers);
}
/** Sends a message between the sender and receiver. */
private static void sendMessage(
TsiFrameProtector sender,
TsiFrameProtector receiver,
int recvFragmentSize,
String message,
RegisterRef ref)
throws GeneralSecurityException {
ByteBuf plaintextBuffer = Unpooled.wrappedBuffer(message.getBytes(UTF_8));
final List<ByteBuf> protectOut = new ArrayList<>();
List<Object> unprotectOut = new ArrayList<>();
sender.protectFlush(
Collections.singletonList(plaintextBuffer),
new Consumer<ByteBuf>() {
@Override
public void accept(ByteBuf buf) {
protectOut.add(buf);
}
},
alloc);
assertThat(protectOut.size()).isEqualTo(1);
ByteBuf protect = ref.register(protectOut.get(0));
while (protect.isReadable()) {
ByteBuf buf = protect;
if (recvFragmentSize > 0) {
int size = Math.min(protect.readableBytes(), recvFragmentSize);
buf = protect.readSlice(size);
}
receiver.unprotect(buf, unprotectOut, alloc);
}
ByteBuf plaintextRecvd = getDirectBuffer(message.getBytes(UTF_8).length, ref);
for (Object unprotect : unprotectOut) {
ByteBuf unprotectBuf = ref.register((ByteBuf) unprotect);
plaintextRecvd.writeBytes(unprotectBuf);
}
assertThat(plaintextRecvd).isEqualTo(Unpooled.wrappedBuffer(message.getBytes(UTF_8)));
}
/** Ping pong test. */
public static void pingPongTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector clientProtector = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector serverProtector = handshakers.getServer().createFrameProtector(alloc);
sendMessage(clientProtector, serverProtector, -1, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, -1, EXAMPLE_MESSAGE2, ref);
clientProtector.destroy();
serverProtector.destroy();
}
/** Ping pong test with exact frame size. */
public static void pingPongExactFrameSizeTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
int frameSize =
EXAMPLE_MESSAGE1.getBytes(UTF_8).length
+ AltsTsiFrameProtector.getHeaderBytes()
+ FakeChannelCrypter.getTagBytes();
TsiFrameProtector clientProtector =
handshakers.getClient().createFrameProtector(frameSize, alloc);
TsiFrameProtector serverProtector =
handshakers.getServer().createFrameProtector(frameSize, alloc);
sendMessage(clientProtector, serverProtector, -1, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, -1, EXAMPLE_MESSAGE1, ref);
clientProtector.destroy();
serverProtector.destroy();
}
/** Ping pong test with small buffer size. */
public static void pingPongSmallBufferTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector clientProtector = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector serverProtector = handshakers.getServer().createFrameProtector(alloc);
sendMessage(clientProtector, serverProtector, 1, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, 1, EXAMPLE_MESSAGE2, ref);
clientProtector.destroy();
serverProtector.destroy();
}
/** Ping pong test with small frame size. */
public static void pingPongSmallFrameTest(
int frameProtectorOverhead, Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
// We send messages using small non-aligned buffers. We use 3 and 5, small primes.
TsiFrameProtector clientProtector =
handshakers.getClient().createFrameProtector(frameProtectorOverhead + 3, alloc);
TsiFrameProtector serverProtector =
handshakers.getServer().createFrameProtector(frameProtectorOverhead + 5, alloc);
sendMessage(clientProtector, serverProtector, EXAMPLE_MESSAGE1_LEN, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, EXAMPLE_MESSAGE2_LEN, EXAMPLE_MESSAGE2, ref);
clientProtector.destroy();
serverProtector.destroy();
}
/** Ping pong test with small frame and small buffer. */
public static void pingPongSmallFrameSmallBufferTest(
int frameProtectorOverhead, Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
// We send messages using small non-aligned buffers. We use 3 and 5, small primes.
TsiFrameProtector clientProtector =
handshakers.getClient().createFrameProtector(frameProtectorOverhead + 3, alloc);
TsiFrameProtector serverProtector =
handshakers.getServer().createFrameProtector(frameProtectorOverhead + 5, alloc);
sendMessage(clientProtector, serverProtector, EXAMPLE_MESSAGE1_LEN, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, EXAMPLE_MESSAGE2_LEN, EXAMPLE_MESSAGE2, ref);
sendMessage(clientProtector, serverProtector, EXAMPLE_MESSAGE1_LEN, EXAMPLE_MESSAGE1, ref);
sendMessage(serverProtector, clientProtector, EXAMPLE_MESSAGE2_LEN, EXAMPLE_MESSAGE2, ref);
clientProtector.destroy();
serverProtector.destroy();
}
/** Test corrupted counter. */
public static void corruptedCounterTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector sender = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector receiver = handshakers.getServer().createFrameProtector(alloc);
String message = "hello world";
ByteBuf plaintextBuffer = Unpooled.wrappedBuffer(message.getBytes(UTF_8));
final List<ByteBuf> protectOut = new ArrayList<>();
List<Object> unprotectOut = new ArrayList<>();
sender.protectFlush(
Collections.singletonList(plaintextBuffer),
new Consumer<ByteBuf>() {
@Override
public void accept(ByteBuf buf) {
protectOut.add(buf);
}
},
alloc);
assertThat(protectOut.size()).isEqualTo(1);
ByteBuf protect = ref.register(protectOut.get(0));
// Unprotect once to increase receiver counter.
receiver.unprotect(protect.slice(), unprotectOut, alloc);
assertThat(unprotectOut.size()).isEqualTo(1);
ref.register((ByteBuf) unprotectOut.get(0));
try {
receiver.unprotect(protect, unprotectOut, alloc);
fail("Exception expected");
} catch (AEADBadTagException ex) {
assertThat(ex).hasMessageThat().containsMatch(DECRYPTION_FAILURE_RE);
}
sender.destroy();
receiver.destroy();
}
/** Test corrupted ciphertext. */
public static void corruptedCiphertextTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector sender = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector receiver = handshakers.getServer().createFrameProtector(alloc);
String message = "hello world";
ByteBuf plaintextBuffer = Unpooled.wrappedBuffer(message.getBytes(UTF_8));
final List<ByteBuf> protectOut = new ArrayList<>();
List<Object> unprotectOut = new ArrayList<>();
sender.protectFlush(
Collections.singletonList(plaintextBuffer),
new Consumer<ByteBuf>() {
@Override
public void accept(ByteBuf buf) {
protectOut.add(buf);
}
},
alloc);
assertThat(protectOut.size()).isEqualTo(1);
ByteBuf protect = ref.register(protectOut.get(0));
int ciphertextIdx = protect.writerIndex() - FakeChannelCrypter.getTagBytes() - 2;
protect.setByte(ciphertextIdx, protect.getByte(ciphertextIdx) + 1);
try {
receiver.unprotect(protect, unprotectOut, alloc);
fail("Exception expected");
} catch (AEADBadTagException ex) {
assertThat(ex).hasMessageThat().containsMatch(DECRYPTION_FAILURE_RE);
}
sender.destroy();
receiver.destroy();
}
/** Test corrupted tag. */
public static void corruptedTagTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector sender = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector receiver = handshakers.getServer().createFrameProtector(alloc);
String message = "hello world";
ByteBuf plaintextBuffer = Unpooled.wrappedBuffer(message.getBytes(UTF_8));
final List<ByteBuf> protectOut = new ArrayList<>();
List<Object> unprotectOut = new ArrayList<>();
sender.protectFlush(
Collections.singletonList(plaintextBuffer),
new Consumer<ByteBuf>() {
@Override
public void accept(ByteBuf buf) {
protectOut.add(buf);
}
},
alloc);
assertThat(protectOut.size()).isEqualTo(1);
ByteBuf protect = ref.register(protectOut.get(0));
int tagIdx = protect.writerIndex() - 1;
protect.setByte(tagIdx, protect.getByte(tagIdx) + 1);
try {
receiver.unprotect(protect, unprotectOut, alloc);
fail("Exception expected");
} catch (AEADBadTagException ex) {
assertThat(ex).hasMessageThat().containsMatch(DECRYPTION_FAILURE_RE);
}
sender.destroy();
receiver.destroy();
}
/** Test reflected ciphertext. */
public static void reflectedCiphertextTest(Handshakers handshakers, RegisterRef ref)
throws GeneralSecurityException {
performHandshake(DEFAULT_TRANSPORT_BUFFER_SIZE, handshakers);
TsiFrameProtector sender = handshakers.getClient().createFrameProtector(alloc);
TsiFrameProtector receiver = handshakers.getServer().createFrameProtector(alloc);
String message = "hello world";
ByteBuf plaintextBuffer = Unpooled.wrappedBuffer(message.getBytes(UTF_8));
final List<ByteBuf> protectOut = new ArrayList<>();
List<Object> unprotectOut = new ArrayList<>();
sender.protectFlush(
Collections.singletonList(plaintextBuffer),
new Consumer<ByteBuf>() {
@Override
public void accept(ByteBuf buf) {
protectOut.add(buf);
}
},
alloc);
assertThat(protectOut.size()).isEqualTo(1);
ByteBuf protect = ref.register(protectOut.get(0));
try {
sender.unprotect(protect.slice(), unprotectOut, alloc);
fail("Exception expected");
} catch (AEADBadTagException ex) {
assertThat(ex).hasMessageThat().containsMatch(DECRYPTION_FAILURE_RE);
}
sender.destroy();
receiver.destroy();
}
}