-
Notifications
You must be signed in to change notification settings - Fork 93
/
Copy pathWebSocket.m
1298 lines (1116 loc) · 48.4 KB
/
WebSocket.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
//
// WebSocket.m
// UnittWebSocketClient
//
// Created by Josh Morris on 9/26/11.
// Copyright 2011 UnitT Software. All rights reserved.
//
// 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.
//
#import <Security/Security.h>
#import "WebSocket.h"
#import "WebSocketFragment.h"
#import "HandshakeHeader.h"
#import "TrustKit+Private.h"
#include <zlib.h>
enum {
WebSocketWaitingStateMessage = 0, //Starting on waiting for a new message
WebSocketWaitingStateHeader = 1, //Waiting for the remaining header bytes
WebSocketWaitingStatePayload = 2, //Waiting for the remaining payload bytes
WebSocketWaitingStateFragment = 3 //Waiting for the next fragment
};
typedef NSUInteger WebSocketWaitingState;
@interface WebSocket (Private)
- (void)repeatPing;
- (void)dispatchFailure:(NSError *)aError;
- (void)dispatchClosed:(NSUInteger)aStatusCode message:(NSString *)aMessage error:(NSError *)aError;
- (void)dispatchOpened;
- (void)dispatchTextMessageReceived:(NSString *)aMessage;
- (void)dispatchBinaryMessageReceived:(NSData *)aMessage;
- (void)continueReadingMessageStream;
- (NSString *)getRequest:(NSString *)aRequestPath;
- (NSData *)getSHA1:(NSData *)aPlainText;
- (void)generateSecKeys;
- (NSString *)getExtensionsAsString:(NSArray *)aExtensions;
- (BOOL)supportsAnotherSupportedVersion:(NSString *)aResponse;
- (BOOL)isUpgradeResponse:(NSString *)aResponse;
- (NSMutableArray *)getServerExtensions:(NSMutableArray *)aServerHeaders;
- (BOOL)isValidServerExtension:(NSArray *)aServerExtensions;
- (void)sendClose:(NSUInteger)aStatusCode message:(NSString *)aMessage;
- (void)sendMessage:(NSData *)aMessage messageWithOpCode:(MessageOpCode)aOpCode;
- (void)sendMessage:(WebSocketFragment *)aFragment;
- (NSInteger)handleMessageData:(NSData *)aData offset:(NSUInteger)aOffset;
- (void)handleCompleteFragment:(WebSocketFragment *)aFragment;
- (void)handleCompleteFragments;
- (void)handleClose:(WebSocketFragment *)aFragment;
- (void)handlePing:(NSData *)aMessage;
- (void)closeSocket;
- (void)checkClose:(NSTimer *)aTimer;
- (NSString *)buildStringFromHeaders:(NSMutableArray *)aHeaders resource:(NSString *)aResource;
- (NSMutableArray *)buildHeadersFromString:(NSString *)aHeaders;
- (HandshakeHeader *)headerForKey:(NSString *)aKey inHeaders:(NSMutableArray *)aHeaders;
- (NSArray *)headersForKey:(NSString *)aKey inHeaders:(NSMutableArray *)aHeaders;
@end
@implementation WebSocket {
BOOL isInContinuation;
}
NSString *const WebSocketException = @"WebSocketException";
NSString *const WebSocketErrorDomain = @"WebSocketErrorDomain";
enum {
TagHandshake = 0,
TagMessage = 1
};
WebSocketWaitingState waitingState;
@synthesize config;
@synthesize delegate;
@synthesize readystate;
#pragma mark Public Interface
- (void)open {
UInt16 port = self.config.isSecure ? 443 : 80;
if (self.config.url.port) {
port = [self.config.url.port intValue];
}
NSError *error = nil;
BOOL successful = false;
@try {
nw_endpoint_t endpoint = nw_endpoint_create_host(self.config.url.host.UTF8String, [NSNumber numberWithInt:port].stringValue.UTF8String);
nw_parameters_configure_protocol_block_t configure_tls = NW_PARAMETERS_DISABLE_PROTOCOL;
if (self.config.isSecure) {
configure_tls = ^(nw_protocol_options_t tls_options) {
sec_protocol_options_t options = nw_tls_copy_sec_protocol_options(tls_options);
sec_protocol_options_set_tls_server_name(options, self.config.host.UTF8String);
sec_protocol_options_set_verify_block(options, ^(sec_protocol_metadata_t metadata, sec_trust_t trust_ref, sec_protocol_verify_complete_t complete) {
SecTrustRef trust = sec_trust_copy_ref(trust_ref);
TSKTrustDecision trustDecision = [TSKPinningValidator evaluateTrust:trust forHostname:self.config.host];
complete(trustDecision != TSKTrustDecisionShouldBlockConnection);
}, dispatch_get_main_queue());
};
}
nw_parameters_t parameters = nw_parameters_create_secure_tcp(configure_tls, ^(nw_protocol_options_t tcp_options) {
nw_tcp_options_set_connection_timeout(tcp_options, self.config.timeout);
});
connection = nw_connection_create(endpoint, parameters);
if (connection != NULL) {
nw_connection_set_queue(connection, networkQueue);
nw_connection_set_state_changed_handler(connection, ^(nw_connection_state_t state, nw_error_t error) {
if (state == nw_connection_state_waiting || state == nw_connection_state_failed) {
[self socketDidDisconnectWithError:(__bridge NSError *)nw_error_copy_cf_error(error)];
} else if (state == nw_connection_state_ready) {
[self socketDidConnectToHost:self.config.url.host port:port];
} else if (state == nw_connection_state_cancelled) {
[self socketDidDisconnectWithError:NULL];
}
});
nw_connection_start(connection);
successful = YES;
}
if (self.config.version == WebSocketVersion07) {
closeStatusCode = WebSocketCloseStatusNormal;
}
else {
closeStatusCode = 0;
}
closeMessage = nil;
}
@catch (NSException *exception) {
error = [NSError errorWithDomain:WebSocketErrorDomain code:0 userInfo:exception.userInfo];
}
@finally {
if (!successful) {
[self dispatchClosed:WebSocketCloseStatusProtocolError message:nil error:error];
}
}
}
- (void)close {
[self close:WebSocketCloseStatusNormal message:nil];
}
- (void)close:(NSUInteger)aStatusCode message:(NSString *)aMessage {
readystate = WebSocketReadyStateClosing;
//any rev before 10 does not perform a UTF8 check
if (self.config.version < WebSocketVersion10) {
[self sendClose:aStatusCode message:aMessage];
}
else {
if (aMessage && [aMessage canBeConvertedToEncoding:NSUTF8StringEncoding]) {
[self sendClose:aStatusCode message:aMessage];
}
else {
[self sendClose:aStatusCode message:nil];
}
}
isClosing = YES;
}
- (void)scheduleForceCloseCheck {
[NSTimer scheduledTimerWithTimeInterval:self.config.closeTimeout
target:self
selector:@selector(checkClose:)
userInfo:nil repeats:NO];
}
- (void)checkClose:(NSTimer *)aTimer {
if (self.readystate == WebSocketReadyStateClosing) {
[self closeSocket];
}
}
- (void)sendClose:(NSUInteger)aStatusCode message:(NSString *)aMessage {
//create payload
NSMutableData *payload = nil;
if (aStatusCode > 0) {
closeStatusCode = aStatusCode;
payload = [NSMutableData data];
unsigned char current = (unsigned char) (aStatusCode / 0x100);
[payload appendBytes:¤t length:1];
current = (unsigned char) (aStatusCode % 0x100);
[payload appendBytes:¤t length:1];
if (aMessage) {
closeMessage = [aMessage copy];
[payload appendData:[aMessage dataUsingEncoding:NSUTF8StringEncoding]];
}
}
//send close message
[self sendMessage:[WebSocketFragment fragmentWithOpCode:MessageOpCodeClose isFinal:YES payload:payload]];
//schedule the force close
if (self.config.closeTimeout >= 0) {
[self scheduleForceCloseCheck];
}
}
- (void)sendText:(NSString *)aMessage {
//no reason to grab data if we won't send it anyways
if (!isClosing) {
//only send non-nil data
if (aMessage) {
if ([aMessage canBeConvertedToEncoding:NSUTF8StringEncoding]) {
[self sendMessage:[aMessage dataUsingEncoding:NSUTF8StringEncoding] messageWithOpCode:MessageOpCodeText];
}
else if (self.config.version >= WebSocketVersion10) {
[self close:WebSocketCloseStatusInvalidData message:nil];
}
}
}
}
- (void)sendBinary:(NSData *)aMessage {
[self sendMessage:aMessage messageWithOpCode:MessageOpCodeBinary];
}
- (void)sendPing:(NSData *)aMessage {
[self sendMessage:aMessage messageWithOpCode:MessageOpCodePing];
}
- (void)sendMessage:(NSData *)aMessage messageWithOpCode:(MessageOpCode)aOpCode {
if (!isClosing) {
BOOL isRSV1 = _deflate;
if(_deflate) {
NSData *deflated = [self deflate:aMessage];
if(deflated) {
aMessage = deflated;
} else {
isRSV1 = NO;
NSLog(@"An error occured while compressing fragment, sending uncompressed");
}
}
NSUInteger messageLength = [aMessage length];
if (messageLength <= self.config.maxPayloadSize) {
//create and send fragment
WebSocketFragment *fragment = [WebSocketFragment fragmentWithOpCode:aOpCode isFinal:YES payload:aMessage];
if(_deflate)
fragment.isRSV1 = isRSV1;
[fragment buildFragment];
[self sendMessage:fragment];
}
else {
NSMutableArray *fragments = [NSMutableArray array];
NSUInteger fragmentCount = messageLength / self.config.maxPayloadSize;
if (messageLength % self.config.maxPayloadSize) {
fragmentCount++;
}
//build fragments
for (int i = 0; i < fragmentCount; i++) {
WebSocketFragment *fragment;
NSUInteger fragmentLength = self.config.maxPayloadSize;
if (i == 0) {
fragment = [WebSocketFragment fragmentWithOpCode:aOpCode isFinal:NO payload:[aMessage subdataWithRange:NSMakeRange(i * self.config.maxPayloadSize, fragmentLength)]];
}
else if (i == fragmentCount - 1) {
fragmentLength = messageLength % self.config.maxPayloadSize;
if (fragmentLength == 0) {
fragmentLength = self.config.maxPayloadSize;
}
fragment = [WebSocketFragment fragmentWithOpCode:MessageOpCodeContinuation isFinal:YES payload:[aMessage subdataWithRange:NSMakeRange(i * self.config.maxPayloadSize, fragmentLength)]];
}
else {
fragment = [WebSocketFragment fragmentWithOpCode:MessageOpCodeContinuation isFinal:NO payload:[aMessage subdataWithRange:NSMakeRange(i * self.config.maxPayloadSize, fragmentLength)]];
}
if(_deflate)
fragment.isRSV1 = YES;
[fragments addObject:fragment];
}
//send fragments
for (WebSocketFragment *fragment in fragments) {
[self sendMessage:fragment];
}
}
}
}
- (void)sendMessage:(WebSocketFragment *)aFragment {
if (!isClosing || aFragment.opCode == MessageOpCodeClose) {
[self writeData:aFragment.fragment withTag:TagMessage];
}
}
#pragma mark Internal Web Socket Logic
- (void)continueReadingMessageStream {
dispatch_block_t schedule_next_receive = ^{
[self readDataWithTag:TagMessage];
};
schedule_next_receive();
}
- (void)repeatPing {
if (readystate == WebSocketReadyStateOpen) {
[self sendPing:nil];
}
}
- (void)startPingTimer {
if (self.config.keepAlive) {
pingTimer = [NSTimer scheduledTimerWithTimeInterval:self.config.keepAlive target:self selector:@selector(repeatPing) userInfo:nil repeats:YES];
}
}
- (void)stopPingTimer {
if (pingTimer) {
[pingTimer invalidate];
}
}
- (void)closeSocket {
readystate = WebSocketReadyStateClosing;
nw_connection_send(connection, NULL, NW_CONNECTION_FINAL_MESSAGE_CONTEXT, true, ^(nw_error_t _Nullable error) {
if (error != NULL) {
[self socketDidDisconnectWithError:(__bridge NSError *)nw_error_copy_cf_error(error)];
}
});
}
- (void)handleCompleteFragment:(WebSocketFragment *)aFragment {
//if we are not in continuation and its final, dequeue
if (aFragment.isFinal && aFragment.opCode != MessageOpCodeContinuation) {
[pendingFragments removeLastObject];
}
//continue to process
switch (aFragment.opCode) {
case MessageOpCodeContinuation:
if (aFragment.isFinal) {
[self handleCompleteFragments];
}
break;
case MessageOpCodeText:
/*if (aFragment.isFinal) {
if (aFragment.payloadData.length) {
NSString *textMsg = [[NSString alloc] initWithData:aFragment.payloadData encoding:NSUTF8StringEncoding];
if (textMsg) {
[self dispatchTextMessageReceived:textMsg];
}
else if (self.config.version >= WebSocketVersion10) {
[self close:WebSocketCloseStatusInvalidData message:nil];
}
}
else {
[self dispatchTextMessageReceived:@""];
}
}
break;*/
case MessageOpCodeBinary:
if (aFragment.isFinal) {
if(&deflate && aFragment.isRSV1)
[self dispatchBinaryMessageReceived:[self inflate:aFragment.payloadData]];
else
[self dispatchBinaryMessageReceived:aFragment.payloadData];
}
break;
case MessageOpCodeClose:
[self handleClose:aFragment];
break;
case MessageOpCodePing:
if (aFragment.payloadLength > 125) {
[self close:WebSocketCloseStatusProtocolError message:@"Pings cannot have payloads longer than 125 octets."];
} else {
[self handlePing:aFragment.payloadData];
}
break;
}
}
//Based on http://stackoverflow.com/a/11389847
- (NSData *)inflate:(NSData*)d
{
@synchronized(zlibLock) {
if([d length] == 0)
return d;
//Append 0x00 0x00 0xFF 0xFF
unsigned char tail[4] = {0,0,255,255};
NSMutableData *data = [d mutableCopy];
[data appendBytes:tail length:4];
NSUInteger full_length = [data length];
NSUInteger half_length = [data length] / 2;
NSMutableData *decompressed = [NSMutableData dataWithLength: full_length + half_length];
BOOL done = NO;
int status;
zstrm_in.next_in = (Bytef *)[data bytes];
zstrm_in.avail_in = (unsigned int)[data length];
zstrm_in.total_out = 0;
while (!done) {
// Make sure we have enough room and reset the lengths.
if (zstrm_in.total_out >= [decompressed length])
[decompressed increaseLengthBy: half_length];
zstrm_in.next_out = [decompressed mutableBytes] + zstrm_in.total_out;
zstrm_in.avail_out = (unsigned int)([decompressed length] - zstrm_in.total_out);
// Inflate another chunk.
status = inflate(&zstrm_in, Z_FULL_FLUSH);
if(zstrm_in.avail_in == 0)
done = YES;
else if (status != Z_OK && status != Z_BUF_ERROR)
break;
}
// Set real length.
if (done) {
[decompressed setLength: zstrm_in.total_out];
return [NSData dataWithData: decompressed];
} else
return nil;
}
}
- (NSData *)deflate:(NSData*)data
{
@synchronized(zlibLock) {
if ([data length] == 0)
return nil;
zstrm_out.next_in=(Bytef *)[data bytes];
zstrm_out.avail_in = (unsigned int)[data length];
zstrm_out.total_out = 0;
NSMutableData *compressed = [NSMutableData dataWithLength:16384]; // 16K chunks for expansion
do {
if (zstrm_out.total_out >= [compressed length])
[compressed increaseLengthBy: 16384];
zstrm_out.next_out = [compressed mutableBytes] + zstrm_out.total_out;
zstrm_out.avail_out = (unsigned int)([compressed length] - zstrm_out.total_out);
deflate(&zstrm_out, Z_FULL_FLUSH);
} while (zstrm_out.avail_out == 0);
//Chop off the 0x00 0x00 0xFF 0xFF from the tail
if(zstrm_out.total_out)
[compressed setLength: zstrm_out.total_out - 4];
else
return nil;
return [NSData dataWithData:compressed];
}
}
- (void)handleCompleteFragments {
WebSocketFragment *fragment = [pendingFragments dequeue];
if (fragment != nil) {
//init
NSMutableData *messageData = [NSMutableData data];
MessageOpCode messageOpCode = fragment.opCode;
//loop through, constructing single message
while (fragment != nil) {
if (fragment.payloadLength > 0) {
if(&deflate && fragment.isRSV1)
[messageData appendData:[self inflate:fragment.payloadData]];
else
[messageData appendData:fragment.payloadData];
}
fragment = [pendingFragments dequeue];
}
//handle final message contents
switch (messageOpCode) {
case MessageOpCodeText: {
if (messageData.length) {
NSString *textMsg = [[NSString alloc] initWithData:messageData encoding:NSUTF8StringEncoding];
if (textMsg) {
[self dispatchTextMessageReceived:textMsg];
}
else if (self.config.version >= WebSocketVersion10) {
[self close:WebSocketCloseStatusInvalidData message:nil];
}
} else {
[self dispatchTextMessageReceived:@""];
}
break;
}
case MessageOpCodeBinary:
[self dispatchBinaryMessageReceived:messageData];
break;
}
}
}
- (void)handleClose:(WebSocketFragment *)aFragment {
NSData *payloadData = aFragment.payloadData;
if(&deflate && aFragment.isRSV1)
payloadData = [self inflate:aFragment.payloadData];
//close status & message
BOOL invalidUTF8 = NO;
if (payloadData) {
NSUInteger length = payloadData.length;
if (length >= 2) {
//get status code
unsigned char buffer[2];
[payloadData getBytes:&buffer length:2];
closeStatusCode = buffer[0] << 8 | buffer[1];
//get message
if (length > 2) {
closeMessage = [[NSString alloc] initWithData:[payloadData subdataWithRange:NSMakeRange(2, length - 2)] encoding:NSUTF8StringEncoding];
if (!closeMessage) {
invalidUTF8 = YES;
}
}
}
}
//handle close
if (isClosing) {
[self closeSocket];
}
else {
isClosing = YES;
if (!invalidUTF8 || self.config.version < WebSocketVersion10) {
[self close:0 message:nil];
}
else {
[self close:WebSocketCloseStatusInvalidData message:nil];
}
}
}
- (void)handlePing:(NSData *)aMessage {
[self sendMessage:aMessage messageWithOpCode:MessageOpCodePong];
if ([delegate respondsToSelector:@selector(didSendPong:)]) {
[delegate didSendPong:aMessage];
}
}
// TODO: use a temporary buffer for the fragment payload instead of a queue of fragments
- (NSInteger)handleMessageData:(NSData *)aData offset:(NSUInteger)aOffset {
//init
NSUInteger lengthOfRemainder = 0;
NSUInteger existingLength = 0;
NSInteger offset = -1;
//grab last fragment, use if not complete
WebSocketFragment *fragment = [pendingFragments lastObject];
if (!fragment || fragment.isValid) {
//assign web socket fragment since the last one was complete
fragment = [[WebSocketFragment alloc] init];
[pendingFragments enqueue:fragment];
}
else {
//grab existing length
existingLength = fragment.fragment.length;
}
NSAssert(fragment != nil, @"Websocket fragment should never be nil");
//if we dont know the length - try to figure it out
if (!fragment.isHeaderValid) {
[fragment parseHeader];
//if we still don't have a length, see if we have enough
if (!fragment.isHeaderValid) {
if (![fragment parseHeader:aData from:aOffset]) {
//if we still don't have a valid length, append all data and return
if (fragment.fragment) {
[fragment.fragment appendData:[aData subdataWithRange:NSMakeRange(aOffset, aData.length - aOffset)]];
} else {
fragment.fragment = [NSMutableData dataWithData:[aData subdataWithRange:NSMakeRange(aOffset, aData.length - aOffset)]];
}
return offset;
}
}
}
//validate reserved bits
if (!self.config.activeExtensionModifiesReservedBits) {
if (!&deflate || fragment.isRSV2 || fragment.isRSV3) {
[self close:WebSocketCloseStatusProtocolError message:[NSString stringWithFormat:@"No extension is defined that modifies reserved bits: RSV1=%@, RSV2=%@, RSV3=%@", fragment.isRSV1 ? @"YES" : @"NO", fragment.isRSV2 ? @"YES" : @"NO", fragment.isRSV3 ? @"YES" : @"NO"]];
}
}
//make sure we have a valid op code
if (fragment.opCode != MessageOpCodeContinuation && fragment.opCode != MessageOpCodeText && fragment.opCode != MessageOpCodeBinary && fragment.opCode != MessageOpCodeClose && fragment.opCode != MessageOpCodePing && fragment.opCode != MessageOpCodePong) {
[self close:WebSocketCloseStatusProtocolError message:@"Illegal Opcode"];
}
//disallow fragmented control op codes
if (fragment.opCode == MessageOpCodePing || fragment.opCode == MessageOpCodePong) {
if (!fragment.isFinal) {
[self close:WebSocketCloseStatusProtocolError message:@"Control frames cannot be fragmented"];
}
}
//validate continuation state
if (fragment.isFinal) {
if (fragment.opCode == MessageOpCodeContinuation && !isInContinuation) {
[self close:WebSocketCloseStatusProtocolError message:[NSString stringWithFormat:@"Cannot send the final fragment without a fragmented stream: isFinal=%@, opCode=%li", fragment.isFinal ? @"YES" : @"NO", (long)fragment.opCode]];
} else if (isInContinuation && !fragment.isControlFrame && fragment.opCode != MessageOpCodeContinuation) {
[self close:WebSocketCloseStatusProtocolError message:[NSString stringWithFormat:@"Cannot embed complete messages in a fragmented stream: isFinal=%@, opCode=%li", fragment.isFinal ? @"YES" : @"NO", (long)fragment.opCode]];
}
} else if (isInContinuation && fragment.opCode != MessageOpCodeContinuation) {
[self close:WebSocketCloseStatusProtocolError message:[NSString stringWithFormat:@"Cannot embed non-control, non-continuation frames in a fragmented stream: isFinal=%@, opCode=%li", fragment.isFinal ? @"YES" : @"NO", (long)fragment.opCode]];
} else if (!isInContinuation && fragment.opCode != MessageOpCodeText && fragment.opCode != MessageOpCodeBinary) {
[self close:WebSocketCloseStatusProtocolError message:@"Illegal continuation start frame"];
}
//determine data length
NSUInteger possibleDataLength = aData.length - aOffset;
NSUInteger actualDataLength = possibleDataLength;
if ((possibleDataLength + existingLength > fragment.messageLength)) {
lengthOfRemainder = possibleDataLength - (fragment.messageLength - existingLength);
actualDataLength = possibleDataLength - lengthOfRemainder;
}
unsigned char *actualData = malloc(actualDataLength);
[aData getBytes:actualData range:NSMakeRange(aOffset, actualDataLength)];
if (fragment.fragment) {
[fragment.fragment appendBytes:actualData length:actualDataLength];
} else {
fragment.fragment = [NSMutableData dataWithBytes:actualData length:actualDataLength];
}
free(actualData);
//parse the data, if possible
if (fragment.canBeParsed) {
if (fragment.hasMask) {
//client is not allowed to receive data that is masked and must fail the connection
[self close:WebSocketCloseStatusProtocolError message:@"Server cannot mask data."];
return offset;
}
[fragment parseContent];
//if we have a complete fragment, handle it
if (fragment.isValid && fragment.isFinal) {
[self handleCompleteFragment:fragment];
}
}
//if we have extra data, handle it
if (fragment.messageLength > 0) {
//if we have an offset, trim the data and call back into
if (lengthOfRemainder > 0) {
offset = actualDataLength + aOffset;
}
}
//set continuation state, if we have a valid fragment
if (fragment.isValid) {
if (fragment.isFinal && fragment.opCode == MessageOpCodeContinuation && isInContinuation) {
isInContinuation = NO;
} else if (!fragment.isFinal && (fragment.opCode == MessageOpCodeText || fragment.opCode == MessageOpCodeBinary)) {
isInContinuation = YES;
}
}
return offset;
}
- (NSData *)getSHA1:(NSData *)aPlainText {
CC_SHA1_CTX ctx;
uint8_t *hashBytes;
NSData *hash;
// Malloc a buffer to hold hash.
hashBytes = malloc(CC_SHA1_DIGEST_LENGTH * sizeof(uint8_t));
memset((void *) hashBytes, 0x0, CC_SHA1_DIGEST_LENGTH);
// Initialize the context.
CC_SHA1_Init(&ctx);
// Perform the hash.
CC_SHA1_Update(&ctx, (void *) [aPlainText bytes], (CC_LONG)[aPlainText length]);
// Finalize the output.
CC_SHA1_Final(hashBytes, &ctx);
// Build up the SHA1 blob.
hash = [NSData dataWithBytes:(const void *) hashBytes length:(NSUInteger) CC_SHA1_DIGEST_LENGTH];
if (hashBytes) free(hashBytes);
return hash;
}
- (NSString *)getRequest:(NSString *)aRequestPath {
//create headers if they are missing
NSMutableArray *headers = self.config.headers;
if (headers == nil) {
headers = [NSMutableArray array];
self.config.headers = headers;
}
//handle security keys
[self generateSecKeys];
[headers addObject:[HandshakeHeader headerWithValue:wsSecKey forKey:@"Sec-WebSocket-Key"]];
//handle host
[headers addObject:[HandshakeHeader headerWithValue:self.config.host forKey:@"Host"]];
//handle origin
if (self.config.useOrigin) {
if (self.config.version < WebSocketVersionRFC6455) {
[headers addObject:[HandshakeHeader headerWithValue:self.config.origin forKey:@"Sec-WebSocket-Origin"]];
} else {
[headers addObject:[HandshakeHeader headerWithValue:self.config.origin forKey:@"Origin"]];
}
}
//handle version
if (self.config.version == WebSocketVersion10) {
[headers addObject:[HandshakeHeader headerWithValue:[NSString stringWithFormat:@"%i", 8] forKey:@"Sec-WebSocket-Version"]];
} else if (self.config.version == WebSocketVersionRFC6455) {
[headers addObject:[HandshakeHeader headerWithValue:[NSString stringWithFormat:@"%i", 13] forKey:@"Sec-WebSocket-Version"]];
} else {
[headers addObject:[HandshakeHeader headerWithValue:[NSString stringWithFormat:@"%lu", (unsigned long)self.config.version] forKey:@"Sec-WebSocket-Version"]];
}
//handle protocol
if (self.config.protocols && self.config.protocols.count > 0) {
//build protocol fragment
NSMutableString *protocolFragment = [NSMutableString string];
for (NSString *item in self.config.protocols) {
if ([protocolFragment length] > 0) {
[protocolFragment appendString:@", "];
}
[protocolFragment appendString:item];
}
//include protocols, if any
if ([protocolFragment length] > 0) {
[headers addObject:[HandshakeHeader headerWithValue:protocolFragment forKey:@"Sec-WebSocket-Protocol"]];
}
}
//handle extensions
if (self.config.extensions && self.config.extensions.count > 0) {
//build extensions fragment
NSString *extensionFragment = [self getExtensionsAsString:self.config.extensions];
//return request with extensions
if ([extensionFragment length] > 0) {
[headers addObject:[HandshakeHeader headerWithValue:extensionFragment forKey:@"Sec-WebSocket-Extensions"]];
}
}
return [self buildStringFromHeaders:headers resource:aRequestPath];
}
- (NSString *)getExtensionsAsString:(NSArray *)aExtensions {
NSMutableString *extensionFragment = [NSMutableString string];
for (id item in aExtensions) {
if ([item isKindOfClass:[NSString class]]) {
if ([extensionFragment length] > 0) {
[extensionFragment appendString:@"; "];
}
[extensionFragment appendString:(NSString *) item];
}
else if ([item isKindOfClass:[NSArray class]]) {
//build ordered list of extensions
NSArray *items = (NSArray *) item;
NSMutableString *itemFragment = [NSMutableString string];
for (NSString *childItem in items) {
if ([itemFragment length] > 0) {
[itemFragment appendString:@", "];
}
[itemFragment appendString:childItem];
}
//add to list of extensions
if ([extensionFragment length] > 0) {
[extensionFragment appendString:@"; "];
}
[extensionFragment appendString:itemFragment];
}
}
return extensionFragment;
}
- (NSString *)buildStringFromHeaders:(NSMutableArray *)aHeaders resource:(NSString *)aResource {
//init
NSMutableString *result = [NSMutableString stringWithFormat:@"GET %@ HTTP/1.1\r\nUpgrade: websocket\r\nConnection: Upgrade\r\n", aResource];
//add headers
if (aHeaders) {
for (HandshakeHeader *header in aHeaders) {
if (header) {
[result appendFormat:@"%@: %@\r\n", header.key, header.value];
}
}
}
//add terminator
[result appendFormat:@"\r\n"];
return result;
}
- (NSMutableArray *)buildHeadersFromString:(NSString *)aHeaders {
NSMutableArray *results = [NSMutableArray array];
NSArray *listItems = [aHeaders componentsSeparatedByString:@"\r\n"];
for (NSString *item in listItems) {
NSRange range = [item rangeOfString:@":" options:NSLiteralSearch];
if (range.location != NSNotFound) {
NSString *key = [item substringWithRange:NSMakeRange(0, range.location)];
key = [key stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
NSString *value = [item substringFromIndex:range.length + range.location];
value = [value stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
[results addObject:[HandshakeHeader headerWithValue:value forKey:key]];
}
}
return results;
}
- (void)generateSecKeys {
NSString *initialString = [NSString stringWithFormat:@"%f", [NSDate timeIntervalSinceReferenceDate]];
NSData *data = [initialString dataUsingEncoding:NSUTF8StringEncoding];
NSString *key = [data base64EncodedString];
wsSecKey = [key copy];
key = [NSString stringWithFormat:@"%@%@", wsSecKey, @"258EAFA5-E914-47DA-95CA-C5AB0DC85B11"];
data = [self getSHA1:[key dataUsingEncoding:NSUTF8StringEncoding]];
key = [data base64EncodedString];
wsSecKeyHandshake = [key copy];
}
- (HandshakeHeader *)headerForKey:(NSString *)aKey inHeaders:(NSMutableArray *)aHeaders {
for (HandshakeHeader *header in aHeaders) {
if (header) {
if ([header keyMatchesCaseInsensitiveString:aKey]) {
return header;
}
}
}
return nil;
}
- (NSArray *)headersForKey:(NSString *)aKey inHeaders:(NSMutableArray *)aHeaders {
NSMutableArray *results = [NSMutableArray array];
for (HandshakeHeader *header in aHeaders) {
if (header) {
if ([header keyMatchesCaseInsensitiveString:aKey]) {
[results addObject:header];
}
}
}
return results;
}
- (BOOL)supportsAnotherSupportedVersion:(NSString *)aResponse {
//a HTTP 400 response is the only valid one
if ([aResponse hasPrefix:@"HTTP/1.1 400"]) {
return [aResponse rangeOfString:@"Sec-WebSocket-Version"].location != NSNotFound;
}
return false;
}
- (BOOL)isUpgradeResponse:(NSString *)aResponse {
//a HTTP 101 response is the only valid one
if ([aResponse hasPrefix:@"HTTP/1.1 101"]) {
//build headers
self.config.serverHeaders = [self buildHeadersFromString:aResponse];
//check security key, if requested
if (self.config.verifySecurityKey) {
HandshakeHeader *header = [self headerForKey:@"Sec-WebSocket-Accept" inHeaders:self.config.serverHeaders];
if (![wsSecKeyHandshake isEqualToString:header.value]) {
return false;
}
}
//verify we have a "Upgrade: websocket" header
HandshakeHeader *header = [self headerForKey:@"Upgrade" inHeaders:self.config.serverHeaders];
if (header.value && [@"websocket" caseInsensitiveCompare:header.value] != NSOrderedSame) {
return false;
}
//verify we have a "Connection: Upgrade" header
header = [self headerForKey:@"Connection" inHeaders:self.config.serverHeaders];
if (header.value && [@"Upgrade" caseInsensitiveCompare:header.value] != NSOrderedSame) {
return false;
}
//verify that version specified matches the version we requested
return true;
}
return false;
}
- (void)sendHandshake {
//continue with handshake
NSString *requestPath = self.config.url.path;
if (requestPath == nil || requestPath.length == 0) {
requestPath = @"/";
}
if (self.config.url.query) {
requestPath = [requestPath stringByAppendingFormat:@"?%@", self.config.url.query];
}
NSString *getRequest = [self getRequest:requestPath];
[self writeData:[getRequest dataUsingEncoding:NSASCIIStringEncoding] withTag:TagHandshake];
}
- (NSMutableArray *)getServerVersions:(NSMutableArray *)aServerHeaders {
NSMutableArray *results = [NSMutableArray array];
NSMutableArray *tempResults = [NSMutableArray array];
//find all entries keyed by Sec-WebSocket-Version or Sec-WebSocket-Version-Server
// [tempResults addObjectsFromArray:[self headersForKey:@"Sec-WebSocket-Version" inHeaders:self.config.serverHeaders]];
// [tempResults addObjectsFromArray:[self headersForKey:@"Sec-WebSocket-Version-Server" inHeaders:self.config.serverHeaders]];
[tempResults addObjectsFromArray:[self headersForKey:@"Sec-WebSocket-Version" inHeaders:aServerHeaders]];
[tempResults addObjectsFromArray:[self headersForKey:@"Sec-WebSocket-Version-Server" inHeaders:aServerHeaders]];
//loop through values trimming and adding to versions
for (HandshakeHeader *header in tempResults) {
NSString *extensionValues = header.value;
NSArray *listItems = [extensionValues componentsSeparatedByString:@","];
for (NSString *item in listItems) {
if (item) {
NSString *value = [item stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
if (value && value.length) {
[results addObject:value];
}
}
}
}
return results;
}
- (NSMutableArray *)getServerExtensions:(NSMutableArray *)aServerHeaders {
NSMutableArray *results = [NSMutableArray array];
//loop through values trimming and adding to extensions
// HandshakeHeader *header = [self headerForKey:@"Sec-WebSocket-Extensions" inHeaders:self.config.serverHeaders];
HandshakeHeader *header = [self headerForKey:@"Sec-WebSocket-Extensions" inHeaders:aServerHeaders];
if (header) {
NSString *extensionValues = header.value;
NSArray *listItems = [extensionValues componentsSeparatedByString:@","];
for (NSString *item in listItems) {
if (item) {
NSString *value = [item stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceCharacterSet]];
if (value && value.length) {
[results addObject:value];
}
}
}
}
return results;
}
- (BOOL)isValidServerExtension:(NSArray *)aServerExtensions {
if (self.config.extensions && self.config.extensions.count > 0) {
//if we only have one extension, see if its in our list of accepted extensions
if (aServerExtensions.count == 1) {
NSString *serverExtension = [aServerExtensions objectAtIndex:0];
for (id item in self.config.extensions) {