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
|
//===----------------------------------------------------------------------===//
//
// This source file is part of the SwiftNIO open source project
//
// Copyright (c) 2017-2018 Apple Inc. and the SwiftNIO project authors
// Licensed under Apache License v2.0
//
// See LICENSE.txt for license information
// See CONTRIBUTORS.txt for the list of SwiftNIO project authors
//
// SPDX-License-Identifier: Apache-2.0
//
//===----------------------------------------------------------------------===//
import XCTest
import NIO
#if compiler(>=5.1)
@_implementationOnly import CNIOBoringSSL
#else
import CNIOBoringSSL
#endif
@testable import NIOSSL
final class ByteBufferBIOTest: XCTestCase {
override func setUp() {
guard boringSSLIsInitialized else {
fatalError("Cannot run tests without BoringSSL")
}
}
/// This leaks on purpose!
private func retainedBIO() -> UnsafeMutablePointer<BIO> {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
swiftBIO.close()
return swiftBIO.retainedBIO()
}
func testExtractingBIOWrite() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
XCTAssertNil(swiftBIO.outboundCiphertext())
var bytesToWrite: [UInt8] = [1, 2, 3, 4, 5]
let rc = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(rc, 5)
guard let extractedBytes = swiftBIO.outboundCiphertext().flatMap({ $0.getBytes(at: $0.readerIndex, length: $0.readableBytes) }) else {
XCTFail("No received bytes")
return
}
XCTAssertEqual(extractedBytes, bytesToWrite)
XCTAssertNil(swiftBIO.outboundCiphertext())
}
func testManyBIOWritesAreCoalesced() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
XCTAssertNil(swiftBIO.outboundCiphertext())
var bytesToWrite: [UInt8] = [1, 2, 3, 4, 5]
var expectedBytes = [UInt8]()
for _ in 0..<10 {
let rc = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(rc, 5)
expectedBytes.append(contentsOf: bytesToWrite)
}
guard let extractedBytes = swiftBIO.outboundCiphertext().flatMap({ $0.getBytes(at: $0.readerIndex, length: $0.readableBytes) }) else {
XCTFail("No received bytes")
return
}
XCTAssertEqual(extractedBytes, expectedBytes)
XCTAssertNil(swiftBIO.outboundCiphertext())
}
func testReadWithNoDataInBIO() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var targetBuffer = [UInt8](repeating: 0, count: 512)
let rc = CNIOBoringSSL_BIO_read(cBIO, &targetBuffer, 512)
XCTAssertEqual(rc, -1)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) != 0)
XCTAssertTrue(CNIOBoringSSL_BIO_should_read(cBIO) != 0)
XCTAssertEqual(targetBuffer, [UInt8](repeating: 0, count: 512))
}
func testReadWithDataInBIO() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var inboundBytes = ByteBufferAllocator().buffer(capacity: 1024)
inboundBytes.writeBytes([1, 2, 3, 4, 5])
swiftBIO.receiveFromNetwork(buffer: inboundBytes)
var receivedBytes = ByteBufferAllocator().buffer(capacity: 1024)
let rc = receivedBytes.writeWithUnsafeMutableBytes(minimumWritableBytes: 1024) { pointer in
let innerRC = CNIOBoringSSL_BIO_read(cBIO, pointer.baseAddress!, CInt(pointer.count))
XCTAssertTrue(innerRC > 0)
return innerRC > 0 ? Int(innerRC) : 0
}
XCTAssertEqual(rc, 5)
XCTAssertEqual(receivedBytes, inboundBytes)
let secondRC = receivedBytes.withUnsafeMutableWritableBytes { pointer in
CNIOBoringSSL_BIO_read(cBIO, pointer.baseAddress!, CInt(pointer.count))
}
XCTAssertEqual(secondRC, -1)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) != 0)
XCTAssertTrue(CNIOBoringSSL_BIO_should_read(cBIO) != 0)
}
func testShortReads() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var inboundBytes = ByteBufferAllocator().buffer(capacity: 1024)
inboundBytes.writeBytes([1, 2, 3, 4, 5])
swiftBIO.receiveFromNetwork(buffer: inboundBytes)
var receivedBytes = ByteBufferAllocator().buffer(capacity: 1024)
for _ in 0..<5 {
let rc = receivedBytes.writeWithUnsafeMutableBytes(minimumWritableBytes: 1024) { pointer in
let innerRC = CNIOBoringSSL_BIO_read(cBIO, pointer.baseAddress!, 1)
XCTAssertTrue(innerRC > 0)
return innerRC > 0 ? Int(innerRC) : 0
}
XCTAssertEqual(rc, 1)
}
XCTAssertEqual(receivedBytes, inboundBytes)
let secondRC = receivedBytes.withUnsafeMutableWritableBytes { pointer in
CNIOBoringSSL_BIO_read(cBIO, pointer.baseAddress!, CInt(pointer.count))
}
XCTAssertEqual(secondRC, -1)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) != 0)
XCTAssertTrue(CNIOBoringSSL_BIO_should_read(cBIO) != 0)
}
func testDropRefToBaseObjectOnRead() throws {
let cBIO = self.retainedBIO()
let receivedBytes = ByteBufferAllocator().buffer(capacity: 1024)
receivedBytes.withVeryUnsafeBytes { pointer in
let rc = CNIOBoringSSL_BIO_read(cBIO, UnsafeMutableRawPointer(mutating: pointer.baseAddress!), 1)
XCTAssertEqual(rc, -1)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) == 0)
}
}
func testDropRefToBaseObjectOnWrite() throws {
let cBIO = self.retainedBIO()
var receivedBytes = ByteBufferAllocator().buffer(capacity: 1024)
receivedBytes.writeBytes([1, 2, 3, 4, 5])
receivedBytes.withVeryUnsafeBytes { pointer in
let rc = CNIOBoringSSL_BIO_write(cBIO, pointer.baseAddress!, 1)
XCTAssertEqual(rc, -1)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) == 0)
}
}
func testZeroLengthReadsAlwaysSucceed() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var targetBuffer = [UInt8](repeating: 0, count: 512)
let rc = CNIOBoringSSL_BIO_read(cBIO, &targetBuffer, 0)
XCTAssertEqual(rc, 0)
XCTAssertEqual(targetBuffer, [UInt8](repeating: 0, count: 512))
}
func testWriteWhenHoldingBufferTriggersCoW() throws {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var bytesToWrite: [UInt8] = [1, 2, 3, 4, 5]
let rc = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(rc, 5)
guard let firstWrite = swiftBIO.outboundCiphertext() else {
XCTFail("Did not write")
return
}
let secondRC = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(secondRC, 5)
guard let secondWrite = swiftBIO.outboundCiphertext() else {
XCTFail("Did not write second time")
return
}
XCTAssertNotEqual(firstWrite.baseAddress(), secondWrite.baseAddress())
}
func testWriteWhenDroppedBufferDoesNotTriggerCoW() {
func writeAddress(swiftBIO: ByteBufferBIO, cBIO: UnsafeMutablePointer<BIO>) -> UInt? {
var bytesToWrite: [UInt8] = [1, 2, 3, 4, 5]
let rc = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(rc, 5)
return swiftBIO.outboundCiphertext()?.baseAddress()
}
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
let firstAddress = writeAddress(swiftBIO: swiftBIO, cBIO: cBIO)
let secondAddress = writeAddress(swiftBIO: swiftBIO, cBIO: cBIO)
XCTAssertNotNil(firstAddress)
XCTAssertNotNil(secondAddress)
XCTAssertEqual(firstAddress, secondAddress)
}
func testZeroLengthWriteIsNoOp() {
// This test works by emulating testWriteWhenHoldingBufferTriggersCoW, but
// with the second write at zero length. This will not trigger a CoW, as no
// actual write will occur.
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var bytesToWrite: [UInt8] = [1, 2, 3, 4, 5]
let rc = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 5)
XCTAssertEqual(rc, 5)
guard let firstWrite = swiftBIO.outboundCiphertext() else {
XCTFail("Did not write")
return
}
withExtendedLifetime(firstWrite) {
let secondRC = CNIOBoringSSL_BIO_write(cBIO, &bytesToWrite, 0)
XCTAssertEqual(secondRC, 0)
XCTAssertNil(swiftBIO.outboundCiphertext())
}
}
func testSimplePuts() {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
XCTAssertNil(swiftBIO.outboundCiphertext())
let stringToWrite = "Hello, world!"
let rc = stringToWrite.withCString {
CNIOBoringSSL_BIO_puts(cBIO, $0)
}
XCTAssertEqual(rc, 13)
let extractedString = swiftBIO.outboundCiphertext().flatMap { $0.getString(at: $0.readerIndex, length: $0.readableBytes) }
XCTAssertEqual(extractedString, stringToWrite)
XCTAssertNil(swiftBIO.outboundCiphertext())
}
func testGetsNotSupported() {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
var buffer = ByteBufferAllocator().buffer(capacity: 1024)
buffer.writeStaticString("Hello, world!")
swiftBIO.receiveFromNetwork(buffer: buffer)
var output = Array<CChar>(repeating: 0, count: 1024)
output.withUnsafeMutableBufferPointer { pointer in
let rc = CNIOBoringSSL_BIO_gets(cBIO, pointer.baseAddress, CInt(pointer.count))
XCTAssertEqual(rc, -2)
XCTAssertTrue(CNIOBoringSSL_BIO_should_retry(cBIO) == 0)
}
}
func testBasicCtrlDance() {
let swiftBIO = ByteBufferBIO(allocator: ByteBufferAllocator())
let cBIO = swiftBIO.retainedBIO()
defer {
CNIOBoringSSL_BIO_free(cBIO)
swiftBIO.close()
}
let originalShutdown = CNIOBoringSSL_BIO_ctrl(cBIO, BIO_CTRL_GET_CLOSE, 0, nil)
XCTAssertEqual(originalShutdown, CLong(BIO_CLOSE))
let rc = CNIOBoringSSL_BIO_set_close(cBIO, CInt(BIO_NOCLOSE))
XCTAssertEqual(rc, 1)
let newShutdown = CNIOBoringSSL_BIO_ctrl(cBIO, BIO_CTRL_GET_CLOSE, 0, nil)
XCTAssertEqual(newShutdown, CLong(BIO_NOCLOSE))
let rc2 = CNIOBoringSSL_BIO_set_close(cBIO, CInt(BIO_CLOSE))
XCTAssertEqual(rc2, 1)
let newShutdown2 = CNIOBoringSSL_BIO_ctrl(cBIO, BIO_CTRL_GET_CLOSE, 0, nil)
XCTAssertEqual(newShutdown2, CLong(BIO_CLOSE))
}
}
extension ByteBuffer {
func baseAddress() -> UInt {
return self.withVeryUnsafeBytes { return UInt(bitPattern: $0.baseAddress! )}
}
}
|
