-
Notifications
You must be signed in to change notification settings - Fork 72
/
ONBSocket.m
1647 lines (1305 loc) · 50.3 KB
/
ONBSocket.m
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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// This code derives from Aaron Jacobs's OneButton Socket, which was
// at the time of writing normally licensed under the terms of the
// GNU General Public License. You can find the "standard" version
// in the CVS repository of OneButton FTP (www.onebutton.org).
//
// The SPECIFIC INCARNATION of OneButton Socket upon which this
// code is based was specially distributed to Greg Hulands on 2006-01-05
// under the terms of a modified BSD-style license rather than the GPL.
// This does not indicate that any other version of OneButton Socket
// is or will be distributed under any license but the GPL.
/*
* Copyright (c) 2005, Aaron Jacobs.
* All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above two paragraph
* note about licensing of OneButton Socket, the above copyright notice,
* this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Aaron Jacobs nor the names of OneButton Socket or
* OneButton FTP may be used to endorse or promote products derived from
* this software without specific prior written permission from Aaron Jacobs.
*
* THIS SOFTWARE IS PROVIDED BY AARON JACOBS "AS IS" AND ANY EXPRESS OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
* EVENT SHALL AARON JACOBS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
* OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
* DAMAGE.
*/
/*
Thanks to Dustin Voss and his public domain AsyncSocket class for both
the inspiration for this class and its method of listening for connections and
handling communication with a delegate.
*/
#import "ONBSocket.h"
#import "ONBSSLContext.h"
#import "InterThreadMessaging.h"
#import <netinet/in.h>
@interface ONBSocket ( ONBSocketPrivateMethods )
// If the current thread is the main thread, send the given message to the socket thread. Otherwise
// send the message to the main thread. Only wait for so long, and if we block for too long
// waiting to send the message then retry later.
- (void)ONB_performSelectorOnOtherThread:(SEL)selector;
- (void)ONB_performSelectorOnOtherThread:(SEL)selector
withObject:(id)object;
- (void)ONB_performSelectorOnOtherThread:(SEL)selector
withObject:(id)object1
withObject:(id)object2;
- (void)ONB_performSelectorOnOtherThread:(SEL)selector
withObject:(id)object1
withObject:(id)object2
withObject:(id)object3;
- (void)ONB_tryToSendMessagesToOtherThread:(id)trash;
@end
@interface ONBSocket ( ONBSocketMainThreadPrivateMethods )
- (void)ONB_didConnect;
- (void)ONB_didReadData:(NSData *)data userInfo:(NSDictionary *)userInfo;
- (void)ONB_didDisconnectWithError:(NSError *)error remainingData:(NSData *)remainingData;
- (void)ONB_didTimeOutForReadWithUserInfo:(NSDictionary *)userInfo;
- (void)ONB_didTimeOutForWriteWithUserInfo:(NSDictionary *)userInfo;
- (void)ONB_setTransferSpeed:(NSNumber *)speed;
- (void)ONB_setReceiveSpeed:(NSNumber *)speed;
- (void)ONB_sslHandshakeSucceeded;
- (void)ONB_sslHandshakeFailedWithError:(NSError *)error;
- (void)ONB_acceptingOnPort:(NSNumber *)port;
- (void)ONB_setLocalHost:(NSString *)host;
- (void)ONB_createNewSocketWithInputStream:(NSInputStream *)inputStream
outputStream:(NSOutputStream *)outputStream;
- (void)ONB_adoptInputStream:(NSInputStream *)inputStream
outputStream:(NSOutputStream *)outputStream;
@end
@interface ONBSocket ( ONBSocketSocketThreadPrivateMethods )
// Set up the run loop on the socket thread.
- (void)ONB_startSocketThread:(id)trash;
// Shut down the socket thread.
- (void)ONB_shutDownSocketThread;
- (void)ONB_acceptConnectionsOnPort:(NSNumber *)port;
- (void)ONB_connectToHost:(NSString *)host port:(NSNumber *)port;
- (void)ONB_readDataOfLength:(NSNumber *)length timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo;
- (void)ONB_readDataUntilData:(NSData *)terminator timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo;
- (void)ONB_readAllAvailableDataWithTimeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo;
- (void)ONB_writeData:(NSData *)data timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo;
- (void)ONB_enableSSL;
- (void)ONB_setUpInputStream:(NSInputStream *)inputStream outputStream:(NSOutputStream *)outputStream;
// Disconnect and send the given error object to the delegate if they
// respond to the appropriate selector.
- (void)ONB_disconnectWithError:(NSError *)error;
// Time out the read/write described by the timer's userInfo object
- (void)ONB_readTimedOut:(NSTimer *)timeoutTimer;
- (void)ONB_writeTimedOut:(NSTimer *)timeoutTimer;
// Close the streams, remove them from the run loop, and release them
- (void)ONB_cleanUpStreams;
// Add a read request to the queue
- (void)ONB_addReadRequest:(NSMutableDictionary *)readRequest;
// Add a write request to the queue
- (void)ONB_addWriteRequest:(NSDictionary *)writeRequest;
// If appropriate, take some decrypted data and use it to fill
// pending read requests
- (void)ONB_workOnReadRequests:(NSTimer *)timer;
// If appropriate, take some data from the top-most write request, encrypt it,
// and put it on the encrypted write data buffer
- (void)ONB_provideEncryptedData;
// The first read request in the queue has been completed. Tell the delegate
// and then remove it from the queue.
- (void)ONB_finishedReadRequestWithData:(NSData *)data;
// The first write request in the queue has been completed. Tell the delegate
// and then remove it from the queue.
- (void)ONB_finishedWriteRequest;
// Add the given encrypted (or raw if SSL is not on) data to the buffer for
// output by the output stream.
- (void)ONB_addDataToEncryptedWriteBuffer:(NSData *)data;
// Add the given encrypted (or raw if SSL is not on) data to the buffer for
// decrypting.
- (void)ONB_addDataToRawDataBuffer:(NSData *)data;
// Add the given decrypted data to the buffer for filling read requests.
- (void)ONB_addDataToDecryptedReadBuffer:(NSData *)data;
// Call this if an error occured while trying to read from the input stream.
- (void)ONB_errorWhileReading;
// Call this if an error occured while trying to write to the output stream.
- (void)ONB_errorWhileWriting;
// Call this if an error occured while trying to perform an SSL handshake.
- (void)ONB_errorDuringHandshake:(int)error;
// Call this if a stream reports an error.
- (void)ONB_errorForStream:(NSStream *)stream;
// Indicate that there is space available for writing on the output stream.
- (void)ONB_outputStreamIsWritable;
// Indicate that there are bytes available for reading on the input stream.
- (void)ONB_inputStreamIsReadable;
// Call this when a stream has finished opening.
- (void)ONB_streamOpenCompleted;
// Call this if a stream reports that its end has been reached.
- (void)ONB_endOfStream:(NSStream *)stream;
// Try to perform an SSL handshake with the other party using any data that has
// come in from the input stream.
- (void)ONB_performHandshake;
// Handle a callback from the CFSocket accepting connects.
- (void)ONB_handleCFSocketCallbackOfType:(CFSocketCallBackType)type
socket:(CFSocketRef)socket
address:(NSData *)address
data:(const void *)data;
// Clean up CFSocket-related objects.
- (void)ONB_cleanUpSockets;
@end
@interface NSData ( ONBDataSearching )
- (NSRange)rangeOfData:(NSData *)data;
- (NSRange)rangeOfData:(NSData *)data range:(NSRange)searchRange;
@end
@implementation NSData ( ONBDataSearching )
- (NSRange)rangeOfData:(NSData *)data
{
return [self rangeOfData:data range:NSMakeRange(0, [self length])];
}
- (NSRange)rangeOfData:(NSData *)data range:(NSRange)searchRange
{
const char *big = [self bytes];
unsigned int bigLength = [self length];
const char *little = [data bytes];
unsigned int littleLength = [data length];
if ((searchRange.location < 0) || (searchRange.location >= bigLength) ||
(searchRange.length < 0) || (searchRange.length + searchRange.location > bigLength))
{
[NSException raise:NSRangeException
format:@"Invalid range (%u, %u) for rangeOfData:range:!",
searchRange.location,
searchRange.length];
return NSMakeRange(NSNotFound, 0);
}
big += searchRange.location;
bigLength = searchRange.length;
NSRange range = NSMakeRange(NSNotFound, 0);
if ((! data) || (! littleLength) || (! bigLength) || (littleLength > bigLength))
return range;
unsigned int bigOffset;
unsigned int littleOffset;
for (bigOffset=0; bigOffset<bigLength - littleLength + 1; bigOffset++)
{
for (littleOffset=0; littleOffset<littleLength; littleOffset++)
if (big[bigOffset + littleOffset] != little[littleOffset])
break;
if (littleOffset == littleLength)
{
range.location = bigOffset + searchRange.location;
range.length = littleLength;
return range;
}
}
return range;
}
@end
void ONB_SocketCallback(CFSocketRef socket,
CFSocketCallBackType callbackType,
CFDataRef address,
const void *data,
void *info)
{
ONBSocket *socketObject = (ONBSocket *)info;
[socketObject ONB_handleCFSocketCallbackOfType:callbackType
socket:socket
address:(NSData *)address
data:data];
}
@implementation ONBSocket
- (id)init
{
return [self initWithDelegate:nil];
}
- (id)initWithDelegate:(id)delegate
{
if (! (self = [super init]))
return nil;
[self setDelegate:delegate];
ONB_toldSocketThreadToShutDown = NO;
ONB_socketThreadInvocations = [[NSMutableArray alloc] initWithCapacity:20];
[self setVerifySSLCertificates:YES];
[self setSSLServerMode:NO];
[self setSSLIdentity:nil];
ONB_transferSpeed = 0.0;
ONB_receiveSpeed = 0.0;
// Start up the socket thread and wait for it to set up.
[NSThread prepareForConnectionInterThreadMessages];
ONB_mainThread = [[NSThread currentThread] retain];
ONB_socketThread = nil;
[NSThread detachNewThreadSelector:@selector(ONB_startSocketThread:) toTarget:self withObject:nil];
while (! ONB_socketThread)
sched_yield();
return self;
}
- (void)dealloc
{
[self setDelegate:nil];
[ONB_mainThread release];
[ONB_socketThreadInvocations release];
[self ONB_setLocalHost:nil];
[self setSSLIdentity:nil];
[super dealloc];
}
- (oneway void)release
{
// When we call detachNewThreadSelector:toTarget:withObject: in our initalizer to
// start up the socket thread, NSThread retains us. So we need to detect when
// the NSThread retain in the only retain left and then shut down the socket thread.
if (([self retainCount] == 2) && (! ONB_toldSocketThreadToShutDown))
{
// Prevent us from calling this twice.
ONB_toldSocketThreadToShutDown = YES;
if ([[NSThread currentThread] isEqual:ONB_socketThread])
[self ONB_shutDownSocketThread];
else
[self ONB_performSelectorOnOtherThread:@selector(ONB_shutDownSocketThread)];
}
[super release];
}
- (id)delegate
{
return ONB_delegate;
}
- (void)setDelegate:(id)delegate
{
// The delegate is a weak reference.
ONB_delegate = delegate;
}
- (void)acceptConnectionsOnPort:(UInt16)port
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_acceptConnectionsOnPort:)
withObject:[NSNumber numberWithInt:port]];
}
- (void)connectToHost:(NSString *)host port:(UInt16)port
{
[self setHost:host port:port];
[self ONB_performSelectorOnOtherThread:@selector(ONB_connectToHost:port:)
withObject:host
withObject:[NSNumber numberWithUnsignedShort:port]];
}
- (void)setHost:(NSString *)host port:(UInt16)port
{
[_host autorelease];
_host = [host copy];
_port = port;
}
- (double)transferSpeed
{
return ONB_transferSpeed;
}
- (double)receiveSpeed
{
return ONB_receiveSpeed;
}
- (NSString *)localHost
{
return ONB_localHost;
}
- (BOOL)verifySSLCertificates
{
return ONB_verifySSLCertificates;
}
- (void)setVerifySSLCertificates:(BOOL)verifySSLCertificates
{
ONB_verifySSLCertificates = verifySSLCertificates;
}
- (ONBSSLIdentity *)sslIdentity
{
return ONB_SSLIdentity;
}
- (void)setSSLIdentity:(ONBSSLIdentity *)sslIdentity
{
[ONB_SSLIdentity autorelease];
ONB_SSLIdentity = [sslIdentity retain];
}
- (BOOL)sslServerMode
{
return ONB_SSLServerMode;
}
- (void)setSSLServerMode:(BOOL)sslServerMode
{
ONB_SSLServerMode = sslServerMode;
}
// Set up a timer to time out the read if necessary, then construct a read request object and add it
// to the queue.
- (void)readDataOfLength:(unsigned int)length
timeout:(NSTimeInterval)timeout
userInfo:(NSDictionary *)userInfo
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_readDataOfLength:timeout:userInfo:)
withObject:[NSNumber numberWithUnsignedInt:length]
withObject:[NSNumber numberWithDouble:timeout]
withObject:userInfo];
}
- (void)readUntilData:(NSData *)terminator
timeout:(NSTimeInterval)timeout
userInfo:(NSDictionary *)userInfo
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_readDataUntilData:timeout:userInfo:)
withObject:[NSData dataWithData:terminator]
withObject:[NSNumber numberWithDouble:timeout]
withObject:userInfo];
}
- (void)readAllAvailableDataWithTimeout:(NSTimeInterval)timeout
userInfo:(NSDictionary *)userInfo
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_readAllAvailableDataWithTimeout:userInfo:)
withObject:[NSNumber numberWithDouble:timeout]
withObject:userInfo];
}
// Set up a timer to time out the write if necessary, then construct a write request object and add it
// to the queue.
- (void)writeData:(NSData *)data
timeout:(NSTimeInterval)timeout
userInfo:(NSDictionary *)userInfo
{
data = [NSData dataWithData:data];
NSNumber *number = [NSNumber numberWithDouble:timeout];
[self ONB_performSelectorOnOtherThread:@selector(ONB_writeData:timeout:userInfo:)
withObject:data
withObject:number
withObject:userInfo];
}
- (void)enableSSL
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_enableSSL)];
}
@end
@implementation ONBSocket ( ONBSocketMainThreadPrivateMethods )
- (void)ONB_didConnect
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socketDidConnect:)])
[delegate socketDidConnect:self];
}
- (void)ONB_didReadData:(NSData *)data userInfo:(NSDictionary *)userInfo
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:didReadData:userInfo:)])
[delegate socket:self didReadData:data userInfo:userInfo];
}
- (void)ONB_didDisconnectWithError:(NSError *)error remainingData:(NSData *)remainingData
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:didDisconnectWithError:remainingData:)])
[delegate socket:self didDisconnectWithError:error remainingData:remainingData];
}
- (void)ONB_didTimeOutForReadWithUserInfo:(NSDictionary *)userInfo
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:didTimeOutForReadWithUserInfo:)])
[delegate socket:self didTimeOutForReadWithUserInfo:userInfo];
}
- (void)ONB_didTimeOutForWriteWithUserInfo:(NSDictionary *)userInfo
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:didTimeOutForWriteWithUserInfo:)])
[delegate socket:self didTimeOutForWriteWithUserInfo:userInfo];
}
- (void)ONB_sslHandshakeSucceeded
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socketSSLHandshakeSucceeded:)])
[delegate socketSSLHandshakeSucceeded:self];
}
- (void)ONB_sslHandshakeFailedWithError:(NSError *)error
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:sslHandshakeFailedWithError:)])
[delegate socket:self sslHandshakeFailedWithError:error];
}
- (void)ONB_acceptingOnPort:(NSNumber *)port
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:acceptingConnectionsOnPort:)])
[delegate socket:self acceptingConnectionsOnPort:[port unsignedIntValue]];
}
- (void)ONB_setLocalHost:(NSString *)host
{
[self willChangeValueForKey:@"localHost"];
[ONB_localHost autorelease];
ONB_localHost = [host copy];
[self didChangeValueForKey:@"localHost"];
}
- (void)ONB_didWriteDataWithUserInfo:(NSDictionary *)userInfo
{
id delegate = [self delegate];
if ([delegate respondsToSelector:@selector(socket:didWriteDataWithUserInfo:)])
[delegate socket:self didWriteDataWithUserInfo:userInfo];
}
- (void)ONB_setTransferSpeed:(NSNumber *)speed
{
[self willChangeValueForKey:@"transferSpeed"];
ONB_transferSpeed = [speed doubleValue];
[self didChangeValueForKey:@"transferSpeed"];
}
- (void)ONB_setReceiveSpeed:(NSNumber *)speed
{
[self willChangeValueForKey:@"receiveSpeed"];
ONB_receiveSpeed = [speed doubleValue];
[self didChangeValueForKey:@"receiveSpeed"];
}
- (void)ONB_createNewSocketWithInputStream:(NSInputStream *)inputStream
outputStream:(NSOutputStream *)outputStream
{
id delegate = [self delegate];
ONBSocket *newSocket = [[[ONBSocket alloc] initWithDelegate:delegate] autorelease];
// Give the new socket the same SSL configuration as us.
[newSocket setVerifySSLCertificates:[self verifySSLCertificates]];
[newSocket setSSLIdentity:[self sslIdentity]];
[newSocket setSSLServerMode:[self sslServerMode]];
if ([delegate respondsToSelector:@selector(socket:didAcceptNewSocket:)])
[delegate socket:self didAcceptNewSocket:newSocket];
[newSocket ONB_adoptInputStream:inputStream outputStream:outputStream];
}
- (void)ONB_adoptInputStream:(NSInputStream *)inputStream
outputStream:(NSOutputStream *)outputStream
{
[self ONB_performSelectorOnOtherThread:@selector(ONB_setUpInputStream:outputStream:)
withObject:inputStream
withObject:outputStream];
}
@end
@implementation ONBSocket ( ONBSocketSocketThreadPrivateMethods )
- (void)ONB_startSocketThread:(id)trash
{
NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
// Initialize all of the objects specific to this thread.
ONB_mainThreadInvocations = [[NSMutableArray alloc] initWithCapacity:20];
ONB_availableReadTag = 0;
ONB_availableWriteTag = 0;
ONB_rawReadData = [[NSMutableData alloc] initWithCapacity:10240];
ONB_decryptedReadData = [[NSMutableData alloc] initWithCapacity:10240];
ONB_encryptedWriteData = [[NSMutableData alloc] initWithCapacity:102400];
ONB_readRequests = [[NSMutableArray alloc] initWithCapacity:5];
ONB_writeRequests = [[NSMutableArray alloc] initWithCapacity:5];
ONB_handshaking = NO;
ONB_sslEnabled = NO;
ONB_streamOpenCount = 0;
ONB_sslContext = [[ONBSSLContext alloc] init];
ONB_acceptSocket = NULL;
ONB_runLoopSource = NULL;
ONB_inputStream = nil;
ONB_outputStream = nil;
// Make sure that we recompute read and write speed right away and that the initial speed is close to zero.
ONB_lastReadSpeedReport.tv_sec = 0;
ONB_bytesReadSinceLastReadSpeedReport = 0;
ONB_lastWriteSpeedReport.tv_sec = 0;
ONB_bytesWrittenSinceLastWriteSpeedReport = 0;
// Get ready to accept inter-thread messages and then indicate that we are set up.
[NSThread prepareForConnectionInterThreadMessages];
ONB_socketThread = [[NSThread currentThread] retain];
// Run the run loop until we are told to shut down.
ONB_stopRunLoop = NO;
BOOL isRunning = NO;
do
{
NSDate *endDate = [NSDate dateWithTimeIntervalSinceNow:1.0];
isRunning = [[NSRunLoop currentRunLoop] runMode:NSDefaultRunLoopMode beforeDate:endDate];
} while (isRunning && (! ONB_stopRunLoop));
// Clean up all of the thread-specific stuff.
[ONB_socketThread release];
ONB_socketThread = nil;
// TODO: Clean up main thread invocations
[ONB_mainThreadInvocations release];
[ONB_rawReadData release];
[ONB_decryptedReadData release];
[ONB_encryptedWriteData release];
[ONB_readRequests release];
[ONB_writeRequests release];
[ONB_sslContext release];
[pool release];
}
- (void)ONB_shutDownSocketThread
{
[self ONB_cleanUpStreams];
[self ONB_cleanUpSockets];
ONB_stopRunLoop = YES;
}
- (void)ONB_acceptConnectionsOnPort:(NSNumber *)port
{
struct sockaddr_in nativeAddr =
{
/*sin_len*/ sizeof(struct sockaddr_in),
/*sin_family*/ AF_INET,
/*sin_port*/ htons ([port intValue]),
/*sin_addr*/ { htonl (INADDR_ANY) },
/*sin_zero*/ { 0 }
};
NSData *address = [NSData dataWithBytes:&nativeAddr length:sizeof(nativeAddr)];
CFSocketContext context;
context.version = 0;
context.info = self;
context.retain = nil;
context.release = nil;
context.copyDescription = nil;
ONB_acceptSocket = CFSocketCreate(kCFAllocatorDefault,
AF_INET,
SOCK_STREAM,
0,
kCFSocketAcceptCallBack,
(CFSocketCallBack)&ONB_SocketCallback,
&context);
ONB_runLoopSource = CFSocketCreateRunLoopSource(kCFAllocatorDefault, ONB_acceptSocket, 0);
CFRunLoopRef runLoop = CFRunLoopGetCurrent();
CFRunLoopAddSource(runLoop, ONB_runLoopSource, kCFRunLoopDefaultMode);
// Set the SO_REUSEADDR flag.
int reuseOn = 1;
setsockopt(CFSocketGetNative(ONB_acceptSocket), SOL_SOCKET, SO_REUSEADDR, &reuseOn, sizeof(int));
CFSocketSetAddress(ONB_acceptSocket, (CFDataRef)address);
// Find out on what port we are now listening.
CFSocketNativeHandle native = CFSocketGetNative(ONB_acceptSocket);
struct sockaddr_in addressStruct;
socklen_t length = sizeof(struct sockaddr_in);
if (getsockname(native, (struct sockaddr *)&addressStruct, &length) == -1)
return;
unsigned int actualPort = addressStruct.sin_port;
[self ONB_performSelectorOnOtherThread:@selector(ONB_acceptingOnPort:)
withObject:[NSNumber numberWithUnsignedInt:actualPort]];
}
- (void)ONB_connectToHost:(NSString *)host port:(NSNumber *)port
{
CFStreamCreatePairWithSocketToHost(kCFAllocatorDefault,
(CFStringRef)host,
[port unsignedShortValue],
(CFReadStreamRef *)&ONB_inputStream,
(CFWriteStreamRef *)&ONB_outputStream); // "Ownership follows the Create Rule."
// Make sure that the streams close the underlying socket when they are closed.
CFReadStreamSetProperty((CFReadStreamRef) ONB_inputStream,
kCFStreamPropertyShouldCloseNativeSocket,
kCFBooleanTrue);
CFWriteStreamSetProperty((CFWriteStreamRef) ONB_outputStream,
kCFStreamPropertyShouldCloseNativeSocket,
kCFBooleanTrue);
[ONB_inputStream setDelegate:self];
[ONB_outputStream setDelegate:self];
NSRunLoop *currentRunLoop = [NSRunLoop currentRunLoop];
[ONB_inputStream scheduleInRunLoop:currentRunLoop forMode:NSDefaultRunLoopMode];
[ONB_outputStream scheduleInRunLoop:currentRunLoop forMode:NSDefaultRunLoopMode];
[ONB_inputStream open];
[ONB_outputStream open];
}
- (void)ONB_readDataOfLength:(NSNumber *)length timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo
{
NSNumber *readTag = [NSNumber numberWithUnsignedInt:ONB_availableReadTag++];
NSMutableDictionary *readRequest = [NSMutableDictionary dictionaryWithObjectsAndKeys:length,
@"terminator",
readTag,
@"readTag",
userInfo,
@"userInfo",
nil];
if ([timeout doubleValue] > 0)
{
// Create a timeout timer for this read
NSDictionary *timerUserInfo = [NSDictionary dictionaryWithObject:readTag forKey:@"readTag"];
NSTimer *timer = [NSTimer scheduledTimerWithTimeInterval:[timeout doubleValue]
target:self
selector:@selector(ONB_readTimedOut:)
userInfo:timerUserInfo
repeats:NO];
[readRequest setObject:timer forKey:@"timeoutTimer"];
}
[self ONB_addReadRequest:readRequest];
}
- (void)ONB_readDataUntilData:(NSData *)terminator timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo
{
NSNumber *readTag = [NSNumber numberWithUnsignedInt:ONB_availableReadTag++];
NSMutableDictionary *readRequest = [NSMutableDictionary dictionaryWithObjectsAndKeys:terminator,
@"terminator",
readTag,
@"readTag",
userInfo,
@"userInfo",
nil];
if ([timeout doubleValue] > 0)
{
// Create a timeout timer for this read
NSDictionary *timerUserInfo = [NSDictionary dictionaryWithObject:readTag forKey:@"readTag"];
NSTimer *timer = [NSTimer scheduledTimerWithTimeInterval:[timeout doubleValue]
target:self
selector:@selector(ONB_readTimedOut:)
userInfo:timerUserInfo
repeats:NO];
[readRequest setObject:timer forKey:@"timeoutTimer"];
}
[self ONB_addReadRequest:readRequest];
}
- (void)ONB_readAllAvailableDataWithTimeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo
{
NSNumber *readTag = [NSNumber numberWithUnsignedInt:ONB_availableReadTag++];
NSMutableDictionary *readRequest = [NSMutableDictionary dictionaryWithObjectsAndKeys:readTag,
@"readTag",
userInfo,
@"userInfo",
nil];
if ([timeout doubleValue] > 0)
{
// Create a timeout timer for this read
NSDictionary *timerUserInfo = [NSDictionary dictionaryWithObject:readTag forKey:@"readTag"];
NSTimer *timer = [NSTimer scheduledTimerWithTimeInterval:[timeout doubleValue]
target:self
selector:@selector(ONB_readTimedOut:)
userInfo:timerUserInfo
repeats:NO];
[readRequest setObject:timer forKey:@"timeoutTimer"];
}
[self ONB_addReadRequest:readRequest];
}
- (void)ONB_writeData:(NSData *)data timeout:(NSNumber *)timeout userInfo:(NSDictionary *)userInfo
{
NSNumber *writeTag = [NSNumber numberWithUnsignedInt:ONB_availableWriteTag++];
NSMutableData *dataContainer = [NSMutableData dataWithData:data];
NSDictionary *writeRequest = [NSDictionary dictionaryWithObjectsAndKeys:dataContainer,
@"remainingData",
@"writeRequest",
@"type",
writeTag,
@"writeTag",
userInfo,
@"userInfo",
nil];
if ([timeout doubleValue] > 0)
{
// Create a timeout timer for this write
NSDictionary *timerUserInfo = [NSDictionary dictionaryWithObject:writeTag forKey:@"writeTag"];
NSTimer *timer = [NSTimer scheduledTimerWithTimeInterval:[timeout doubleValue]
target:self
selector:@selector(ONB_writeTimedOut:)
userInfo:timerUserInfo
repeats:NO];
writeRequest = [NSMutableDictionary dictionaryWithDictionary:writeRequest];
[(NSMutableDictionary *)writeRequest setObject:timer forKey:@"timeoutTimer"];
}
[self ONB_addWriteRequest:writeRequest];
}
- (void)ONB_enableSSL
{
// Add an object to the write queue that indicates that we should perform an SSL handshake.
// We don't try to do it immediately so that that any pending write requests can finish first.
NSDictionary *writeRequest = [NSDictionary dictionaryWithObject:@"sslHandshake" forKey:@"type"];
[self ONB_addWriteRequest:writeRequest];
}
- (void)stream:(NSStream *)stream handleEvent:(NSStreamEvent)streamEvent
{
switch (streamEvent)
{
case NSStreamEventHasSpaceAvailable:
[self ONB_outputStreamIsWritable];
return;
case NSStreamEventHasBytesAvailable:
[self ONB_inputStreamIsReadable];
return;
case NSStreamEventOpenCompleted:
[self ONB_streamOpenCompleted];
return;
case NSStreamEventErrorOccurred:
[self ONB_errorForStream:stream];
return;
case NSStreamEventEndEncountered:
[self ONB_endOfStream:stream];
return;
case NSStreamEventNone:
return;
default:
{
NSNumber *eventCode = [NSNumber numberWithInt:streamEvent];
NSDictionary *userInfo = [NSDictionary dictionaryWithObject:eventCode forKey:@"streamEvent"];
[self ONB_disconnectWithError:[NSError errorWithDomain:ONBSocketErrorDomain
code:ONBUnhandledStreamEvent
userInfo:userInfo]];
NSLog(@"Unhandled stream event: %u", streamEvent);
}
return;
}
}
- (void)ONB_setUpInputStream:(NSInputStream *)inputStream
outputStream:(NSOutputStream *)outputStream
{
ONB_inputStream = [inputStream retain];
ONB_outputStream = [outputStream retain];
[ONB_inputStream setDelegate:self];
[ONB_outputStream setDelegate:self];
NSRunLoop *currentRunLoop = [NSRunLoop currentRunLoop];
[ONB_inputStream scheduleInRunLoop:currentRunLoop forMode:NSDefaultRunLoopMode];
[ONB_outputStream scheduleInRunLoop:currentRunLoop forMode:NSDefaultRunLoopMode];
[ONB_inputStream open];
[ONB_outputStream open];
}
- (void)ONB_addReadRequest:(NSMutableDictionary *)readRequest
{
[ONB_readRequests addObject:readRequest];
[self ONB_workOnReadRequests:nil];
}
- (void)ONB_addWriteRequest:(NSDictionary *)writeRequest
{
[ONB_writeRequests addObject:writeRequest];
[self ONB_provideEncryptedData];
}
- (void)ONB_performHandshake
{
NSMutableData *outputData = [NSMutableData data];
int ret = [ONB_sslContext handshakeWithInputData:ONB_rawReadData outputData:outputData];
if ([outputData length])
[self ONB_addDataToEncryptedWriteBuffer:outputData];
if (ret < 0)
{
[self ONB_errorDuringHandshake:ret];
return;
}
if (ret == 1)
{
ONB_handshaking = NO;
ONB_sslEnabled = YES;
[self ONB_performSelectorOnOtherThread:@selector(ONB_sslHandshakeSucceeded)];
[self ONB_provideEncryptedData];
return;
}
// Wait to be called again when more data is retreived.
}
- (void)ONB_provideEncryptedData
{
// If there's already data on the buffer, don't do anything.
if ([ONB_encryptedWriteData length])
return;
// If there's no write request to get data from, don't do anything.
if (! [ONB_writeRequests count])
return;
// Don't do anything if we're currently handshaking.
if (ONB_handshaking)
return;
// Keep going through the write requests trying to get data until we have
// either provided some data or run out of write requests to process.
while ((! [ONB_encryptedWriteData length]) && [ONB_writeRequests count])
{
NSDictionary *writeRequest = [ONB_writeRequests objectAtIndex:0];
NSString *type = [writeRequest objectForKey:@"type"];
if ([type isEqual:@"sslHandshake"])
{
ONB_handshaking = YES;
// Remove the sslHandshake write request
[ONB_writeRequests removeObjectAtIndex:0];
// Give our SSL context the appropriate parameters.
[ONB_sslContext setVerifySSLCertificates:[self verifySSLCertificates]];
[ONB_sslContext setSSLIdentity:[self sslIdentity]];
[ONB_sslContext setSSLServerMode:[self sslServerMode]];
// Put any data we've read recently back onto the raw data buffer, since
// it should be SSL handshake data.
[ONB_rawReadData setData:ONB_decryptedReadData];