Merge pull request #985 from AzureAD/release/1.6.4

April release: common core release/1.6.4

Author: mipetriu

IdentityCore/IdentityCore.xcodeproj/project.pbxproj

@@ -553,6 +553,9 @@
 		60F94D332210E8BD0035D956 /* MSIDV1IdToken.m in Sources */ = {isa = PBXBuildFile; fileRef = 60F94D312210E8BD0035D956 /* MSIDV1IdToken.m */; };
 		60FDA9C521A18D3F001E09B8 /* MSIDDefaultBrokerRequestTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 60FDA9C421A18D3F001E09B8 /* MSIDDefaultBrokerRequestTests.m */; };
 		60FDA9C721A19DA6001E09B8 /* MSIDDefaultBrokerResponseHandlerTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 60FDA9C621A19DA6001E09B8 /* MSIDDefaultBrokerResponseHandlerTests.m */; };
+		6599299D26296AA600830FD5 /* MSIDRequestTelemetryConstants.h in Headers */ = {isa = PBXBuildFile; fileRef = 6599299C26296AA600830FD5 /* MSIDRequestTelemetryConstants.h */; };
+		659929AB26296B0200830FD5 /* MSIDRequestTelemetryConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = 659929AA26296B0200830FD5 /* MSIDRequestTelemetryConstants.m */; };
+		659929AC26296B0200830FD5 /* MSIDRequestTelemetryConstants.m in Sources */ = {isa = PBXBuildFile; fileRef = 659929AA26296B0200830FD5 /* MSIDRequestTelemetryConstants.m */; };
 		6E4F658C24D488010070CA36 /* MSIDSymmetricKey.h in Headers */ = {isa = PBXBuildFile; fileRef = 6E4F658B24D488010070CA36 /* MSIDSymmetricKey.h */; };
 		6E4F658E24D4883A0070CA36 /* MSIDSymmetricKey.m in Sources */ = {isa = PBXBuildFile; fileRef = 6E4F658D24D4883A0070CA36 /* MSIDSymmetricKey.m */; };
 		6E4F658F24D4883A0070CA36 /* MSIDSymmetricKey.m in Sources */ = {isa = PBXBuildFile; fileRef = 6E4F658D24D4883A0070CA36 /* MSIDSymmetricKey.m */; };
@@ -2216,6 +2219,8 @@
 		60FDA9C621A19DA6001E09B8 /* MSIDDefaultBrokerResponseHandlerTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDDefaultBrokerResponseHandlerTests.m; sourceTree = "<group>"; };
 		60FDA9D921A5EBBA001E09B8 /* MSIDTestCacheAccessorHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSIDTestCacheAccessorHelper.h; sourceTree = "<group>"; };
 		60FDA9DA21A5EBCF001E09B8 /* MSIDTestCacheAccessorHelper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDTestCacheAccessorHelper.m; sourceTree = "<group>"; };
+		6599299C26296AA600830FD5 /* MSIDRequestTelemetryConstants.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSIDRequestTelemetryConstants.h; sourceTree = "<group>"; };
+		659929AA26296B0200830FD5 /* MSIDRequestTelemetryConstants.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDRequestTelemetryConstants.m; sourceTree = "<group>"; };
 		6E4F658B24D488010070CA36 /* MSIDSymmetricKey.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = MSIDSymmetricKey.h; sourceTree = "<group>"; };
 		6E4F658D24D4883A0070CA36 /* MSIDSymmetricKey.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDSymmetricKey.m; sourceTree = "<group>"; };
 		6E4F659024D48B120070CA36 /* MSIDSymmetricKeyTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = MSIDSymmetricKeyTests.m; sourceTree = "<group>"; };
@@ -3411,6 +3416,8 @@
 				74F04D48246C8AC000094017 /* MSIDLastRequestTelemetrySerializedItem.m */,
 				74F04D4C246CB5B100094017 /* MSIDCurrentRequestTelemetrySerializedItem+Internal.h */,
 				74D926C224B3EFC300AA4270 /* MSIDLastRequestTelemetry+Internal.h */,
+				6599299C26296AA600830FD5 /* MSIDRequestTelemetryConstants.h */,
+				659929AA26296B0200830FD5 /* MSIDRequestTelemetryConstants.m */,
 			);
 			path = request_telemetry;
 			sourceTree = "<group>";
@@ -5356,6 +5363,7 @@
 				B286B9A72389DD2E007833AD /* MSIDAADOAuthEmbeddedWebviewController.h in Headers */,
 				58B81F8224AD0F8B00E8799E /* MSIDWebResponseBaseOperation.h in Headers */,
 				23B5DF76234030B2002C530F /* MSIDRequestParameters+Broker.h in Headers */,
+				6599299D26296AA600830FD5 /* MSIDRequestTelemetryConstants.h in Headers */,
 				239D72D423625EF40008C76A /* MSIDJsonSerializableFactory.h in Headers */,
 				23B5DF7D234031EE002C530F /* MSIDSSOExtensionSilentTokenRequestController.h in Headers */,
 				B227035422A3633700030ADC /* MSIDMaskedLogParameter.h in Headers */,
@@ -6565,6 +6573,7 @@
 				B2C707F52192524700D917B8 /* MSIDDefaultTokenRequestProvider.m in Sources */,
 				B8DBEF652395CA6100A16651 /* MSIDKeychainTokenCache.m in Sources */,
 				600D19BE20964D9E0004CD43 /* MSIDWorkPlaceJoinUtil.m in Sources */,
+				659929AC26296B0200830FD5 /* MSIDRequestTelemetryConstants.m in Sources */,
 				58B81F8424AD0F8B00E8799E /* MSIDWebResponseBaseOperation.m in Sources */,
 				B214C3A01FE854FE0070C4F2 /* MSIDLegacyTokenCacheAccessor.m in Sources */,
 				1E62D0E5228B75E3000E2BBC /* MSIDKeychainUtil.m in Sources */,
@@ -7000,6 +7009,7 @@
 				B28BDA85217E9676003E5670 /* MSIDB2CIdTokenClaims.m in Sources */,
 				B26CEAFF2367ACFA009E6E54 /* MSIDSFAuthenticationSessionHandler.m in Sources */,
 				B2AF1D27218BCD900080C1A0 /* MSIDBrokerInteractiveController.m in Sources */,
+				659929AB26296B0200830FD5 /* MSIDRequestTelemetryConstants.m in Sources */,
 				23B018A023554B2B00207FEC /* MSIDBrokerOperationTokenRequest.m in Sources */,
 				B210F4381FDDEA23005A8F76 /* MSIDAADV1TokenResponse.m in Sources */,
 				A0C7DE7525D465CD00F5B5B6 /* MSIDThrottlingModelBase.m in Sources */,

IdentityCore/src/IdentityCore.pch

@@ -36,7 +36,7 @@
 #import <AppKit/AppKit.h>
 #endif
 
-// Broker SDK relies on having ADAL_BROKER defined to 1.
+// Broker SDK relies on having AD_BROKER defined to 1.
 // This is defined in the ADAuthenticationBroker/Frameworks/aad_overrides.h file.
 // Without this, the build for Broker will not include this definition.
 #if __has_include("../../../../../aad_overrides.h")

IdentityCore/src/MSIDError.h

@@ -21,15 +21,15 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 // THE SOFTWARE.
 
-extern NSString *MSIDErrorDescriptionKey;
-extern NSString *MSIDOAuthErrorKey;
-extern NSString *MSIDOAuthSubErrorKey;
-extern NSString *MSIDCorrelationIdKey;
-extern NSString *MSIDHTTPHeadersKey;
-extern NSString *MSIDHTTPResponseCodeKey;
-extern NSString *MSIDUserDisplayableIdkey;
-extern NSString *MSIDHomeAccountIdkey;
-extern NSString *MSIDBrokerVersionKey;
+extern NSString * _Nonnull MSIDErrorDescriptionKey;
+extern NSString * _Nonnull MSIDOAuthErrorKey;
+extern NSString * _Nonnull MSIDOAuthSubErrorKey;
+extern NSString * _Nonnull MSIDCorrelationIdKey;
+extern NSString * _Nonnull MSIDHTTPHeadersKey;
+extern NSString * _Nonnull MSIDHTTPResponseCodeKey;
+extern NSString * _Nonnull MSIDUserDisplayableIdkey;
+extern NSString * _Nonnull MSIDHomeAccountIdkey;
+extern NSString * _Nonnull MSIDBrokerVersionKey;
 
 /*!
  ADAL and MSID use different error domains and error codes.
@@ -38,10 +38,10 @@ extern NSString *MSIDBrokerVersionKey;
  domain mapping and error code mapping should be added to ADAuthenticationErrorConverter
  and MSIDErrorConveter in corresponding project.
  */
-extern NSString *MSIDErrorDomain;
-extern NSString *MSIDOAuthErrorDomain;
-extern NSString *MSIDKeychainErrorDomain;
-extern NSString *MSIDHttpErrorCodeDomain;
+extern NSString * _Nonnull MSIDErrorDomain;
+extern NSString * _Nonnull MSIDOAuthErrorDomain;
+extern NSString * _Nonnull MSIDKeychainErrorDomain;
+extern NSString * _Nonnull MSIDHttpErrorCodeDomain;
 
 /*!
  List of scopes that were requested from MSAL, but not granted in the response.
@@ -53,22 +53,22 @@ extern NSString *MSIDHttpErrorCodeDomain;
  * Requested scope is not supported for a particular account (Organizational scopes when it is a consumer account)
 
  */
-extern NSString *MSIDDeclinedScopesKey;
+extern NSString * _Nonnull MSIDDeclinedScopesKey;
 
 /*!
  List of granted scopes in case some scopes weren't granted (see MSALDeclinedScopesKey for more info)
  */
-extern NSString *MSIDGrantedScopesKey;
+extern NSString * _Nonnull MSIDGrantedScopesKey;
 
 /*!
  This flag will be set if server is unavailable
  */
-extern NSString *MSIDServerUnavailableStatusKey;
+extern NSString * _Nonnull MSIDServerUnavailableStatusKey;
 
 /*!
  This flag will be set if we received a valid token response, but returned data mismatched.
  */
-extern NSString *MSIDInvalidTokenResultKey;
+extern NSString * _Nonnull MSIDInvalidTokenResultKey;
 
 /*!
  SSO extension failed with underlying error.
@@ -244,10 +244,10 @@ typedef NS_ENUM(NSInteger, MSIDErrorCode)
     MSIDErrorBrokerNotAvailable                    =   -51814
 };
 
-extern NSError *MSIDCreateError(NSString *domain, NSInteger code, NSString *errorDescription, NSString *oauthError, NSString *subError, NSError *underlyingError, NSUUID *correlationId, NSDictionary *additionalUserInfo, BOOL logErrorDescription);
+extern NSError * _Nonnull MSIDCreateError(NSString * _Nonnull domain, NSInteger code, NSString * _Nullable errorDescription, NSString * _Nullable oauthError, NSString * _Nullable subError, NSError * _Nullable underlyingError, NSUUID * _Nullable correlationId, NSDictionary * _Nullable additionalUserInfo, BOOL logErrorDescription);
 
-extern MSIDErrorCode MSIDErrorCodeForOAuthError(NSString *oauthError, MSIDErrorCode defaultCode);
+extern MSIDErrorCode MSIDErrorCodeForOAuthError(NSString * _Nullable oauthError, MSIDErrorCode defaultCode);
 
-extern NSDictionary<NSString *, NSArray *> *MSIDErrorDomainsAndCodes(void);
+extern NSDictionary<NSString *, NSArray *> * _Nonnull MSIDErrorDomainsAndCodes(void);
 
-extern void MSIDFillAndLogError(NSError **error, MSIDErrorCode errorCode, NSString *errorDescription, NSUUID *correlationID);
+extern void MSIDFillAndLogError(NSError * _Nullable __autoreleasing * _Nullable error, MSIDErrorCode errorCode, NSString * _Nullable errorDescription, NSUUID * _Nullable correlationID);

IdentityCore/src/MSIDOAuth2Constants.h

@@ -37,6 +37,8 @@ extern NSString *const MSID_OAUTH2_ERROR;
 extern NSString *const MSID_OAUTH2_ERROR_DESCRIPTION;
 extern NSString *const MSID_OAUTH2_ERROR_SUBCODE;
 extern NSString *const MSID_OAUTH2_EXPIRES_IN;
+extern NSString *const MSID_OAUTH2_REFRESH_IN;
+extern NSString *const MSID_OAUTH2_REFRESH_ON;
 extern NSString *const MSID_OAUTH2_GRANT_TYPE;
 extern NSString *const MSID_OAUTH2_REDIRECT_URI;
 extern NSString *const MSID_OAUTH2_REFRESH_TOKEN;

IdentityCore/src/MSIDOAuth2Constants.m

@@ -70,6 +70,8 @@
 NSString *const MSID_OAUTH2_REQUEST_ENDPOINT = @"endpointUrl";
 
 NSString *const MSID_OAUTH2_EXPIRES_ON          = @"expires_on";
+NSString *const MSID_OAUTH2_REFRESH_IN          = @"refresh_in";
+NSString *const MSID_OAUTH2_REFRESH_ON          = @"refresh_on";
 NSString *const MSID_OAUTH2_EXT_EXPIRES_IN      = @"ext_expires_in";
 NSString *const MSID_FAMILY_ID                  = @"foci";
 NSString *const MSID_ENROLLMENT_ID              = @"microsoft_enrollment_id";

IdentityCore/src/auth_scheme/MSIDAuthenticationScheme.h

@@ -43,7 +43,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic, readonly) MSIDAuthScheme authScheme;
 @property (nonatomic, readonly) NSDictionary *schemeParameters;
 @property (nonatomic, readonly) MSIDCredentialType credentialType;
-@property (nonatomic, readonly) NSString *tokenType;
+@property (nonatomic, nullable, readonly) NSString *tokenType;
 @property (nonatomic, readonly) MSIDAccessToken *accessToken;
 
 - (instancetype)initWithSchemeParameters:(NSDictionary *)schemeParameters;

IdentityCore/src/broker_operation/response/MSIDBrokerNativeAppOperationResponse.h

@@ -40,6 +40,7 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nonatomic) MSIDDeviceInfo *deviceInfo;
 
 @property (nonatomic) NSNumber *httpStatusCode;
+@property (nonatomic, class, readonly) NSNumber *defaultHttpStatusCode;
 @property (nonatomic, nullable) NSDictionary *httpHeaders;
 @property (nonatomic) NSString *httpVersion;
 

IdentityCore/src/broker_operation/response/MSIDBrokerNativeAppOperationResponse.m

@@ -67,11 +67,16 @@ + (NSString *)responseType
 
 - (NSNumber *)httpStatusCode
 {
-    if (!_httpStatusCode) _httpStatusCode = @200;
+    if (_httpStatusCode == nil) _httpStatusCode = self.class.defaultHttpStatusCode;
 
     return _httpStatusCode;
 }
 
++ (NSNumber *)defaultHttpStatusCode
+{
+    return @200;
+}
+
 - (NSString *)httpVersion
 {
     if (!_httpVersion) _httpVersion = @"HTTP/1.1";

IdentityCore/src/cache/crypto/MSIDAssymetricKeyGenerating.h

@@ -30,13 +30,13 @@ NS_ASSUME_NONNULL_BEGIN
 
 @protocol MSIDAssymetricKeyGenerating <NSObject>
 
-- (MSIDAssymetricKeyPair *)generateKeyPairForAttributes:(MSIDAssymetricKeyLookupAttributes *)attributes
-                                                  error:(NSError **)error;
+- (nullable MSIDAssymetricKeyPair *)generateKeyPairForAttributes:(MSIDAssymetricKeyLookupAttributes *)attributes
+                                                           error:(NSError **)error;
 
 - (MSIDAssymetricKeyPair *)readOrGenerateKeyPairForAttributes:(MSIDAssymetricKeyLookupAttributes *)attributes
                                                         error:(NSError **)error;
 
-- (MSIDAssymetricKeyPair *)readKeyPairForAttributes:(MSIDAssymetricKeyLookupAttributes *)attributes
+- (nullable MSIDAssymetricKeyPair *)readKeyPairForAttributes:(MSIDAssymetricKeyLookupAttributes *)attributes
                                               error:(NSError **)error;
 
 - (MSIDAssymetricKeyPair *)generateEphemeralKeyPair:(NSError **)error;

IdentityCore/src/cache/crypto/MSIDAssymetricKeyKeychainGenerator.m

@@ -290,7 +290,7 @@ - (NSDictionary *)additionalPlatformKeychainAttributes
 
 #pragma mark - Utils
 
-- (void)logAndFillError:(NSString *)errorTitle status:(OSStatus)status error:(NSError **)error
+- (BOOL)logAndFillError:(NSString *)errorTitle status:(OSStatus)status error:(NSError **)error
 {
     NSString *description = [NSString stringWithFormat:@"Operation failed with title \"%@\", status %ld", errorTitle, (long)status];
     MSID_LOG_WITH_CTX(MSIDLogLevelError, nil, @"%@", description);
@@ -299,6 +299,8 @@ - (void)logAndFillError:(NSString *)errorTitle status:(OSStatus)status error:(NS
     {
         *error = MSIDCreateError(MSIDErrorDomain, MSIDErrorInternal, description, nil, nil, nil, nil, nil, NO);
     }
+    
+    return YES;
 }
 
 @end