Customize user agent (#223)

IldarAbdullin-okta · web-flow · commit 478ca9d7aa32 · 2020-04-29T15:25:30.000-07:00
* OKTA-293234 - OIDC-IOS: Support customized User-Agent
diff --git a/Okta/Framework/Info.plist b/Okta/Framework/Info.plist
@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>3.6.1</string>
+	<string>3.7.0</string>
 	<key>CFBundleVersion</key>
 	<string>$(CURRENT_PROJECT_VERSION)</string>
 </dict>
diff --git a/Okta/OktaOidc/Internal/OktaUserAgent.h b/Okta/OktaOidc/Internal/OktaUserAgent.h
@@ -16,6 +16,7 @@ NS_ASSUME_NONNULL_BEGIN
 
 @interface OktaUserAgent : NSObject
 
++(void)setUserAgentValue:(NSString*)value;
 +(NSString*)userAgentVersion;
 +(NSString*)userAgentHeaderKey;
 +(NSString*)userAgentHeaderValue;
diff --git a/Okta/OktaOidc/Internal/OktaUserAgent.m b/Okta/OktaOidc/Internal/OktaUserAgent.m
@@ -15,32 +15,42 @@
 
 @implementation OktaUserAgent
 
+static NSString *userAgentValue = nil;
+
++(void)setUserAgentValue:(NSString*)value {
+    userAgentValue = value;
+}
+
 +(NSString*)userAgentVersion {
-    return @"3.6.1";
+    return @"3.7.0";
 }
 
 +(NSString*)userAgentHeaderKey {
     return @"User-Agent";
 }
 
 +(NSString*)userAgentHeaderValue {
-    
-    NSString *bundleVersion = [self.class userAgentVersion];
-    NSString *systemVersion = [[NSProcessInfo processInfo] operatingSystemVersionString];
-    struct utsname deviceInfo;
-    uname(&deviceInfo);
-    NSString *deviceModel = [NSString stringWithUTF8String:deviceInfo.machine];
-    NSString *osName = @"iOS";
-#ifdef __MAC_OS_X_VERSION_MIN_REQUIRED
-    osName = @"macOS";
+
+    if (userAgentValue.length > 0) {
+        return userAgentValue;
+    } else {
+        NSString *bundleVersion = [self.class userAgentVersion];
+        NSString *systemVersion = [[NSProcessInfo processInfo] operatingSystemVersionString];
+        struct utsname deviceInfo;
+        uname(&deviceInfo);
+        NSString *deviceModel = [NSString stringWithUTF8String:deviceInfo.machine];
+        NSString *osName = @"iOS";
+#ifdef __MAC_OS_X_VERSION_MIN_REQUIRE
+        osName = @"macOS";
 #endif
 
-    NSString *formattedString = [NSString stringWithFormat:@"okta-oidc-ios/%@ %@/%@ Device/%@",
-                                 bundleVersion.length > 0 ? bundleVersion : @"",
-                                 osName,
-                                 systemVersion,
-                                 deviceModel];
-    return formattedString;
+        NSString *formattedString = [NSString stringWithFormat:@"okta-oidc-ios/%@ %@/%@ Device/%@",
+                                     bundleVersion.length > 0 ? bundleVersion : @"",
+                                     osName,
+                                     systemVersion,
+                                     deviceModel];
+        return formattedString;
+    }
 }
 
 @end
diff --git a/Okta/OktaOidc/OktaOidcConfig.swift b/Okta/OktaOidc/OktaOidcConfig.swift
@@ -64,19 +64,9 @@ public class OktaOidcConfig: NSObject, Codable {
         
         try self.init(with: configDict)
     }
-    
-    private static func extractAdditionalParams(_ config: [String: String]) -> [String: String]? {
-        // Parse the additional parameters to be passed to the /authorization endpoint
-        var configCopy = config
-        
-        // Remove "issuer", "clientId", "redirectUri", "scopes" and "logoutRedirectUri"
-        configCopy.removeValue(forKey: "issuer")
-        configCopy.removeValue(forKey: "clientId")
-        configCopy.removeValue(forKey: "redirectUri")
-        configCopy.removeValue(forKey: "scopes")
-        configCopy.removeValue(forKey: "logoutRedirectUri")
-        
-        return configCopy
+
+    public class func setUserAgent(value: String) {
+        OktaUserAgent.setUserAgentValue(value)
     }
     
     override public func isEqual(_ object: Any?) -> Bool {
@@ -108,6 +98,20 @@ public class OktaOidcConfig: NSObject, Codable {
         OIDURLSessionProvider.setSession(session)
     }
 
+    private static func extractAdditionalParams(_ config: [String: String]) -> [String: String]? {
+        // Parse the additional parameters to be passed to the /authorization endpoint
+        var configCopy = config
+        
+        // Remove "issuer", "clientId", "redirectUri", "scopes" and "logoutRedirectUri"
+        configCopy.removeValue(forKey: "issuer")
+        configCopy.removeValue(forKey: "clientId")
+        configCopy.removeValue(forKey: "redirectUri")
+        configCopy.removeValue(forKey: "scopes")
+        configCopy.removeValue(forKey: "logoutRedirectUri")
+        
+        return configCopy
+    }
+
     class RedirectBlockingURLSessionDelegate: NSObject, URLSessionTaskDelegate {
         
         static let shared = RedirectBlockingURLSessionDelegate()
diff --git a/OktaOidc.podspec b/OktaOidc.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name             = 'OktaOidc'
-  s.version          = '3.6.1'
+  s.version          = '3.7.0'
   s.summary          = 'SDK to easily integrate AppAuth with Okta'
   s.description      = <<-DESC
 Integrate your native app with Okta using the AppAuth library.
@@ -23,15 +23,25 @@ Integrate your native app with Okta using the AppAuth library.
   s.subspec 'Okta' do |okta|
      okta.dependency 'OktaOidc/AppAuth'
      okta.subspec 'Classes' do |classes|
-        classes.source_files = 'Okta/OktaOidc/*.{h,m,swift}','Okta/OktaOidc/Internal/*.{h,m,swift}','Okta/OktaOidc/Internal/Tasks/*.{h,m,swift}'
-        classes.exclude_files = 'Okta/OktaOidc/OktaOidc.swift','Okta/OktaOidc/iOS/OktaOidc+Browser.swift','Okta/OktaOidc/macOS/OktaOidc+Browser.swift'
-        classes.ios.source_files = 'Okta/OktaOidc/iOS/*.{swift}','Okta/OktaOidc/Internal/iOS/*.{swift}','Okta/OktaOidc/Internal/Tasks/iOS/*.{swift}'
+        classes.source_files = 'Okta/OktaOidc/*.{h,m,swift}',
+                                            'Okta/OktaOidc/Internal/*.{h,m,swift}',
+                                            'Okta/OktaOidc/Internal/Tasks/*.{h,m,swift}'
+        classes.exclude_files = 'Okta/OktaOidc/OktaOidc.swift',
+                                              'Okta/OktaOidc/iOS/OktaOidc+Browser.swift',
+                                              'Okta/OktaOidc/macOS/OktaOidc+Browser.swift'
+        classes.ios.source_files = 'Okta/OktaOidc/iOS/*.{swift}',
+                                                  'Okta/OktaOidc/Internal/iOS/*.{swift}',
+                                                  'Okta/OktaOidc/Internal/Tasks/iOS/*.{swift}'
         classes.ios.deployment_target = '9.0'
-        classes.osx.source_files = 'Okta/OktaOidc/macOS/*.{swift}','Okta/OktaOidc/Internal/macOS/*.{swift}','Okta/OktaOidc/Internal/Tasks/macOS/*.{swift}'
+        classes.osx.source_files = 'Okta/OktaOidc/macOS/*.{swift}',
+                                                   'Okta/OktaOidc/Internal/macOS/*.{swift}',
+                                                   'Okta/OktaOidc/Internal/Tasks/macOS/*.{swift}'
         classes.osx.deployment_target = '10.10'        
      end
      okta.source_files = 'Okta/OktaOidc/OktaOidc.swift'
      okta.ios.source_files = 'Okta/OktaOidc/iOS/OktaOidc+Browser.swift'
      okta.osx.source_files = 'Okta/OktaOidc/macOS/OktaOidc+Browser.swift'
   end
+
+s.xcconfig = { 'USER_HEADER_SEARCH_PATHS' => '${SRCROOT}/OktaOidc/**' }
 end
diff --git a/Tests/OktaOidcConfigTests.swift b/Tests/OktaOidcConfigTests.swift
@@ -165,4 +165,9 @@ class OktaOidcConfigTests: XCTestCase {
         
         XCTAssertNil(config)
     }
+
+    func testUserAgent() {
+        OktaOidcConfig.setUserAgent(value: "some user agent")
+        XCTAssertEqual(OktaUserAgent.userAgentHeaderValue(), "some user agent")
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -165,4 +165,9 @@ class OktaOidcConfigTests: XCTestCase {`
`165`	`165`
`166`	`166`	`XCTAssertNil(config)`
`167`	`167`	`}`
	`168`	`+`
	`169`	`+ func testUserAgent() {`
	`170`	`+ OktaOidcConfig.setUserAgent(value: "some user agent")`
	`171`	`+ XCTAssertEqual(OktaUserAgent.userAgentHeaderValue(), "some user agent")`
	`172`	`+ }`
`168`	`173`	`}`