补充某些必要的文件

2026-06-29 17:06:33 +00:00 · 2022-06-25 11:52:00 +08:00
parent 4ecc470f86
commit 03533b046c
2869 changed files with 1345388 additions and 2 deletions
@@ -0,0 +1,20 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern NSError *SRErrorWithDomainCodeDescription(NSString *domain, NSInteger code, NSString *description);
+extern NSError *SRErrorWithCodeDescription(NSInteger code, NSString *description);
+extern NSError *SRErrorWithCodeDescriptionUnderlyingError(NSInteger code, NSString *description, NSError *underlyingError);
+
+extern NSError *SRHTTPErrorWithCodeDescription(NSInteger httpCode, NSInteger errorCode, NSString *description);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,42 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRError.h"
+
+#import "SRWebSocket.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+NSError *SRErrorWithDomainCodeDescription(NSString *domain, NSInteger code, NSString *description)
+{
+    return [NSError errorWithDomain:domain code:code userInfo:@{ NSLocalizedDescriptionKey: description }];
+}
+
+NSError *SRErrorWithCodeDescription(NSInteger code, NSString *description)
+{
+    return SRErrorWithDomainCodeDescription(SRWebSocketErrorDomain, code, description);
+}
+
+NSError *SRErrorWithCodeDescriptionUnderlyingError(NSInteger code, NSString *description, NSError *underlyingError)
+{
+    return [NSError errorWithDomain:SRWebSocketErrorDomain
+                               code:code
+                           userInfo:@{ NSLocalizedDescriptionKey: description,
+                                       NSUnderlyingErrorKey: underlyingError }];
+}
+
+NSError *SRHTTPErrorWithCodeDescription(NSInteger httpCode, NSInteger errorCode, NSString *description)
+{
+    return [NSError errorWithDomain:SRWebSocketErrorDomain
+                               code:errorCode
+                           userInfo:@{ NSLocalizedDescriptionKey: description,
+                                       SRHTTPResponseErrorKey: @(httpCode) }];
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,20 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern CFHTTPMessageRef SRHTTPConnectMessageCreate(NSURLRequest *request,
+                                                   NSString *securityKey,
+                                                   uint8_t webSocketProtocolVersion,
+                                                   NSArray<NSHTTPCookie *> *_Nullable cookies,
+                                                   NSArray<NSString *> *_Nullable requestedProtocols);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,79 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRHTTPConnectMessage.h"
+
+#import "SRURLUtilities.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+static NSString *_SRHTTPConnectMessageHost(NSURL *url)
+{
+    NSString *host = url.host;
+    if (url.port) {
+        host = [host stringByAppendingFormat:@":%@", url.port];
+    }
+    return host;
+}
+
+CFHTTPMessageRef SRHTTPConnectMessageCreate(NSURLRequest *request,
+                                            NSString *securityKey,
+                                            uint8_t webSocketProtocolVersion,
+                                            NSArray<NSHTTPCookie *> *_Nullable cookies,
+                                            NSArray<NSString *> *_Nullable requestedProtocols)
+{
+    NSURL *url = request.URL;
+
+    CFHTTPMessageRef message = CFHTTPMessageCreateRequest(NULL, CFSTR("GET"), (__bridge CFURLRef)url, kCFHTTPVersion1_1);
+
+    // Set host first so it defaults
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Host"), (__bridge CFStringRef)_SRHTTPConnectMessageHost(url));
+
+    NSMutableData *keyBytes = [[NSMutableData alloc] initWithLength:16];
+    int result = SecRandomCopyBytes(kSecRandomDefault, keyBytes.length, keyBytes.mutableBytes);
+    if (result != 0) {
+        //TODO: (nlutsenko) Check if there was an error.
+    }
+
+    // Apply cookies if any have been provided
+    if (cookies) {
+        NSDictionary<NSString *, NSString *> *messageCookies = [NSHTTPCookie requestHeaderFieldsWithCookies:cookies];
+        [messageCookies enumerateKeysAndObjectsUsingBlock:^(NSString * _Nonnull key, NSString * _Nonnull obj, BOOL * _Nonnull stop) {
+            if (key.length && obj.length) {
+                CFHTTPMessageSetHeaderFieldValue(message, (__bridge CFStringRef)key, (__bridge CFStringRef)obj);
+            }
+        }];
+    }
+
+    // set header for http basic auth
+    NSString *basicAuthorizationString = SRBasicAuthorizationHeaderFromURL(url);
+    if (basicAuthorizationString) {
+        CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Authorization"), (__bridge CFStringRef)basicAuthorizationString);
+    }
+
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Upgrade"), CFSTR("websocket"));
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Connection"), CFSTR("Upgrade"));
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Sec-WebSocket-Key"), (__bridge CFStringRef)securityKey);
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Sec-WebSocket-Version"), (__bridge CFStringRef)@(webSocketProtocolVersion).stringValue);
+
+    CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Origin"), (__bridge CFStringRef)SRURLOrigin(url));
+
+    if (requestedProtocols.count) {
+        CFHTTPMessageSetHeaderFieldValue(message, CFSTR("Sec-WebSocket-Protocol"),
+                                         (__bridge CFStringRef)[requestedProtocols componentsJoinedByString:@", "]);
+    }
+
+    [request.allHTTPHeaderFields enumerateKeysAndObjectsUsingBlock:^(id key, id obj, BOOL *stop) {
+        CFHTTPMessageSetHeaderFieldValue(message, (__bridge CFStringRef)key, (__bridge CFStringRef)obj);
+    }];
+
+    return message;
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,19 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern NSData *SRSHA1HashFromString(NSString *string);
+extern NSData *SRSHA1HashFromBytes(const char *bytes, size_t length);
+
+extern NSString *SRBase64EncodedStringFromData(NSData *data);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,43 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRHash.h"
+
+#import <CommonCrypto/CommonDigest.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+NSData *SRSHA1HashFromString(NSString *string)
+{
+    size_t length = [string lengthOfBytesUsingEncoding:NSUTF8StringEncoding];
+    return SRSHA1HashFromBytes(string.UTF8String, length);
+}
+
+NSData *SRSHA1HashFromBytes(const char *bytes, size_t length)
+{
+    uint8_t outputLength = CC_SHA1_DIGEST_LENGTH;
+    unsigned char output[outputLength];
+    CC_SHA1(bytes, (CC_LONG)length, output);
+
+    return [NSData dataWithBytes:output length:outputLength];
+}
+
+NSString *SRBase64EncodedStringFromData(NSData *data)
+{
+    if ([data respondsToSelector:@selector(base64EncodedStringWithOptions:)]) {
+        return [data base64EncodedStringWithOptions:0];
+    }
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wdeprecated-declarations"
+    return [data base64Encoding];
+#pragma clang diagnostic pop
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,20 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+// Uncomment this line to enable debug logging
+//#define SR_DEBUG_LOG_ENABLED
+
+extern void SRErrorLog(NSString *format, ...);
+extern void SRDebugLog(NSString *format, ...);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,33 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRLog.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern void SRErrorLog(NSString *format, ...)
+{
+    __block va_list arg_list;
+    va_start (arg_list, format);
+
+    NSString *formattedString = [[NSString alloc] initWithFormat:format arguments:arg_list];
+
+    va_end(arg_list);
+
+    NSLog(@"[SocketRocket] %@", formattedString);
+}
+
+extern void SRDebugLog(NSString *format, ...)
+{
+#ifdef SR_DEBUG_LOG_ENABLED
+    SRErrorLog(tag, format);
+#endif
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,22 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef __attribute__((capability("mutex"))) pthread_mutex_t *SRMutex;
+
+extern SRMutex SRMutexInitRecursive(void);
+extern void SRMutexDestroy(SRMutex mutex);
+
+extern void SRMutexLock(SRMutex mutex) __attribute__((acquire_capability(mutex)));
+extern void SRMutexUnlock(SRMutex mutex) __attribute__((release_capability(mutex)));
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,47 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRMutex.h"
+
+#import <pthread/pthread.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+SRMutex SRMutexInitRecursive(void)
+{
+    pthread_mutex_t *mutex = malloc(sizeof(pthread_mutex_t));
+    pthread_mutexattr_t attributes;
+
+    pthread_mutexattr_init(&attributes);
+    pthread_mutexattr_settype(&attributes, PTHREAD_MUTEX_RECURSIVE);
+    pthread_mutex_init(mutex, &attributes);
+    pthread_mutexattr_destroy(&attributes);
+
+    return mutex;
+}
+
+void SRMutexDestroy(SRMutex mutex)
+{
+    pthread_mutex_destroy(mutex);
+    free(mutex);
+}
+
+__attribute__((no_thread_safety_analysis))
+void SRMutexLock(SRMutex mutex)
+{
+    pthread_mutex_lock(mutex);
+}
+
+__attribute__((no_thread_safety_analysis))
+void SRMutexUnlock(SRMutex mutex)
+{
+    pthread_mutex_unlock(mutex);
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,16 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+extern NSData *SRRandomData(NSUInteger length);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,26 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRRandom.h"
+
+#import <Security/SecRandom.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+NSData *SRRandomData(NSUInteger length)
+{
+    NSMutableData *data = [NSMutableData dataWithLength:length];
+    int result = SecRandomCopyBytes(kSecRandomDefault, data.length, data.mutableBytes);
+    if (result != 0) {
+        [NSException raise:NSInternalInconsistencyException format:@"Failed to generate random bytes with OSStatus: %d", result];
+    }
+    return data;
+}
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,19 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+/**
+ Unmask bytes using XOR via SIMD.
+
+ @param bytes    The bytes to unmask.
+ @param length   The number of bytes to unmask.
+ @param maskKey The mask to XOR with MUST be of length sizeof(uint32_t).
+ */
+void SRMaskBytesSIMD(uint8_t *bytes, size_t length, uint8_t *maskKey);
@@ -0,0 +1,73 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRSIMDHelpers.h"
+
+typedef uint8_t uint8x32_t __attribute__((vector_size(32)));
+
+static void SRMaskBytesManual(uint8_t *bytes, size_t length, uint8_t *maskKey) {
+    for (size_t i = 0; i < length; i++) {
+        bytes[i] = bytes[i] ^ maskKey[i % sizeof(uint32_t)];
+    }
+}
+
+/**
+ Right-shift the elements of a vector, circularly.
+
+ @param vector The vector to circular shift.
+ @param by     The number of elements to shift by.
+
+ @return A shifted vector.
+ */
+static uint8x32_t SRShiftVector(uint8x32_t vector, size_t by) {
+    uint8x32_t vectorCopy = vector;
+    by = by % _Alignof(uint8x32_t);
+
+    uint8_t *vectorPointer = (uint8_t *)&vector;
+    uint8_t *vectorCopyPointer = (uint8_t *)&vectorCopy;
+
+    memmove(vectorPointer + by, vectorPointer, sizeof(vector) - by);
+    memcpy(vectorPointer, vectorCopyPointer + (sizeof(vector) - by), by);
+
+    return vector;
+}
+
+void SRMaskBytesSIMD(uint8_t *bytes, size_t length, uint8_t *maskKey) {
+    size_t alignmentBytes = _Alignof(uint8x32_t) - ((uintptr_t)bytes % _Alignof(uint8x32_t));
+    if (alignmentBytes == _Alignof(uint8x32_t)) {
+        alignmentBytes = 0;
+    }
+
+    // If the number of bytes that can be processed after aligning is
+    // less than the number of bytes we can put into a vector,
+    // then there's no work to do with SIMD, just call the manual version.
+    if (alignmentBytes > length || (length - alignmentBytes) < sizeof(uint8x32_t)) {
+        SRMaskBytesManual(bytes, length, maskKey);
+        return;
+    }
+
+    size_t vectorLength = (length - alignmentBytes) / sizeof(uint8x32_t);
+    size_t manualStartOffset = alignmentBytes + (vectorLength * sizeof(uint8x32_t));
+    size_t manualLength = length - manualStartOffset;
+
+    uint8x32_t *vector = (uint8x32_t *)(bytes + alignmentBytes);
+    uint8x32_t maskVector = { };
+
+    memset_pattern4(&maskVector, maskKey, sizeof(uint8x32_t));
+    maskVector = SRShiftVector(maskVector, alignmentBytes);
+
+    SRMaskBytesManual(bytes, alignmentBytes, maskKey);
+
+    for (size_t vectorIndex = 0; vectorIndex < vectorLength; vectorIndex++) {
+        vector[vectorIndex] = vector[vectorIndex] ^ maskVector;
+    }
+
+    // Use the shifted mask for the final manual part.
+    SRMaskBytesManual(bytes + manualStartOffset, manualLength, (uint8_t *) &maskVector);
+}
@@ -0,0 +1,26 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+// The origin isn't really applicable for a native application.
+// So instead, just map ws -> http and wss -> https.
+extern NSString *SRURLOrigin(NSURL *url);
+
+extern BOOL SRURLRequiresSSL(NSURL *url);
+
+// Extracts `user` and `password` from url (if available) into `Basic base64(user:password)`.
+extern NSString *_Nullable SRBasicAuthorizationHeaderFromURL(NSURL *url);
+
+// Returns a valid value for `NSStreamNetworkServiceType` or `nil`.
+extern NSString *_Nullable SRStreamNetworkServiceTypeFromURLRequest(NSURLRequest *request);
+
+NS_ASSUME_NONNULL_END
@@ -0,0 +1,77 @@
+//
+// Copyright (c) 2016-present, Facebook, Inc.
+// All rights reserved.
+//
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+//
+
+#import "SRURLUtilities.h"
+
+#import "SRHash.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+NSString *SRURLOrigin(NSURL *url)
+{
+    NSMutableString *origin = [NSMutableString string];
+
+    NSString *scheme = url.scheme.lowercaseString;
+    if ([scheme isEqualToString:@"wss"]) {
+        scheme = @"https";
+    } else if ([scheme isEqualToString:@"ws"]) {
+        scheme = @"http";
+    }
+    [origin appendFormat:@"%@://%@", scheme, url.host];
+
+    NSNumber *port = url.port;
+    BOOL portIsDefault = (!port ||
+                          ([scheme isEqualToString:@"http"] && port.integerValue == 80) ||
+                          ([scheme isEqualToString:@"https"] && port.integerValue == 443));
+    if (!portIsDefault) {
+        [origin appendFormat:@":%@", port.stringValue];
+    }
+    return origin;
+}
+
+extern BOOL SRURLRequiresSSL(NSURL *url)
+{
+    NSString *scheme = url.scheme.lowercaseString;
+    return ([scheme isEqualToString:@"wss"] || [scheme isEqualToString:@"https"]);
+}
+
+extern NSString *_Nullable SRBasicAuthorizationHeaderFromURL(NSURL *url)
+{
+    NSData *data = [[NSString stringWithFormat:@"%@:%@", url.user, url.password] dataUsingEncoding:NSUTF8StringEncoding];
+    return [NSString stringWithFormat:@"Basic %@", SRBase64EncodedStringFromData(data)];
+}
+
+extern NSString *_Nullable SRStreamNetworkServiceTypeFromURLRequest(NSURLRequest *request)
+{
+    NSString *networkServiceType = nil;
+    switch (request.networkServiceType) {
+        case NSURLNetworkServiceTypeDefault:
+            break;
+        case NSURLNetworkServiceTypeVoIP:
+            networkServiceType = NSStreamNetworkServiceTypeVoIP;
+            break;
+        case NSURLNetworkServiceTypeVideo:
+            networkServiceType = NSStreamNetworkServiceTypeVideo;
+            break;
+        case NSURLNetworkServiceTypeBackground:
+            networkServiceType = NSStreamNetworkServiceTypeBackground;
+            break;
+        case NSURLNetworkServiceTypeVoice:
+            networkServiceType = NSStreamNetworkServiceTypeVoice;
+            break;
+#if (__MAC_OS_X_VERSION_MAX_ALLOWED >= 101200 || __IPHONE_OS_VERSION_MAX_ALLOWED >= 100000 || __TV_OS_VERSION_MAX_ALLOWED >= 100000 || __WATCH_OS_VERSION_MAX_ALLOWED >= 30000)
+        case NSURLNetworkServiceTypeCallSignaling:
+            networkServiceType = NSStreamNetworkServiceTypeCallSignaling;
+            break;
+#endif
+    }
+    return networkServiceType;
+}
+
+NS_ASSUME_NONNULL_END