Merge pull request #1443 from matrix-org/doug/authentication

pixlwave · web-flow · commit 817b9b95e036 · 2022-04-27T12:02:47.000+01:00
Add MXUsernameAvailability and an msisdn MXLoginFlowType.
diff --git a/MatrixSDK/Contrib/Swift/JSONModels/MXJSONModels.swift b/MatrixSDK/Contrib/Swift/JSONModels/MXJSONModels.swift
@@ -23,6 +23,7 @@ public enum MXLoginFlowType: Equatable, Hashable {
     case recaptcha
     case OAuth2
     case emailIdentity
+    case msisdn
     case token
     case dummy
     case emailCode
@@ -34,6 +35,7 @@ public enum MXLoginFlowType: Equatable, Hashable {
         case .recaptcha: return kMXLoginFlowTypeRecaptcha
         case .OAuth2: return kMXLoginFlowTypeOAuth2
         case .emailIdentity: return kMXLoginFlowTypeEmailIdentity
+        case .msisdn: return kMXLoginFlowTypeMSISDN
         case .token: return kMXLoginFlowTypeToken
         case .dummy: return kMXLoginFlowTypeDummy
         case .emailCode: return kMXLoginFlowTypeEmailCode
@@ -42,8 +44,8 @@ public enum MXLoginFlowType: Equatable, Hashable {
     }
 
     public init(identifier: String) {
-        let flowTypess: [MXLoginFlowType] = [.password, .recaptcha, .OAuth2, .emailIdentity, .token, .dummy, .emailCode]
-        self = flowTypess.first(where: { $0.identifier == identifier }) ?? .other(identifier)
+        let flowTypes: [MXLoginFlowType] = [.password, .recaptcha, .OAuth2, .emailIdentity, .msisdn, .token, .dummy, .emailCode]
+        self = flowTypes.first(where: { $0.identifier == identifier }) ?? .other(identifier)
     }
 }
 
diff --git a/MatrixSDK/Contrib/Swift/MXRestClient.swift b/MatrixSDK/Contrib/Swift/MXRestClient.swift
@@ -107,10 +107,25 @@ public extension MXRestClient {
      
      - returns: a `MXHTTPOperation` instance.
      */
+    @available(*, deprecated, message: "Use isUsernameAvailable instead which calls the dedicated API and provides more information.")
     @nonobjc @discardableResult func isUserNameInUse(_ username: String, completion: @escaping (_ inUse: Bool) -> Void) -> MXHTTPOperation {
         return __isUserName(inUse: username, callback: completion)
     }
     
+    /**
+     Checks whether a username is available.
+     
+     - parameters:
+         - username: The user name to test.
+         - completion: A block object called when the operation is completed.
+         - response: Provides the server response as an `MXUsernameAvailability` instance.
+     
+     - returns: a `MXHTTPOperation` instance.
+     */
+    @nonobjc @discardableResult func isUsernameAvailable(_ username: String, completion: @escaping (_ response: MXResponse<MXUsernameAvailability>) -> Void) -> MXHTTPOperation {
+        return __isUsernameAvailable(username, success: currySuccess(completion), failure: curryFailure(completion))
+    }
+    
     /**
      Get the list of register flows supported by the home server.
      
diff --git a/MatrixSDK/Data/AutoDiscovery/MXAutoDiscovery.h b/MatrixSDK/Data/AutoDiscovery/MXAutoDiscovery.h
@@ -55,7 +55,7 @@ NS_ASSUME_NONNULL_BEGIN
                              failure:(void (^)(NSError *error))failure;;
 
 /**
- Get the wellknwon data of the homeserver.
+ Get the wellknown data of the homeserver.
 
  @param success A block object called when the operation succeeds. It provides
                 the wellknown data.
diff --git a/MatrixSDK/JSONModels/Login/MXLoginSSOFlow.m b/MatrixSDK/JSONModels/Login/MXLoginSSOFlow.m
@@ -32,15 +32,15 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
     
     if (loginFlow)
     {
-        NSArray *jsonIdentityProdivers;
+        NSArray *jsonIdentityProviders;
         
-        MXJSONModelSetArray(jsonIdentityProdivers, JSONDictionary[MXLoginSSOFlowIdentityProvidersKey]);
+        MXJSONModelSetArray(jsonIdentityProviders, JSONDictionary[MXLoginSSOFlowIdentityProvidersKey]);
         
         NSArray<MXLoginSSOIdentityProvider*> *identityProviders;
         
-        if (jsonIdentityProdivers)
+        if (jsonIdentityProviders)
         {
-            identityProviders = [MXLoginSSOIdentityProvider modelsFromJSON:jsonIdentityProdivers];
+            identityProviders = [MXLoginSSOIdentityProvider modelsFromJSON:jsonIdentityProviders];
         }
 
         if (!identityProviders)
diff --git a/MatrixSDK/JSONModels/MXJSONModels.h b/MatrixSDK/JSONModels/MXJSONModels.h
@@ -173,6 +173,18 @@ FOUNDATION_EXPORT NSString *const kMXLoginIdentifierTypePhone;
 
 @end
 
+/**
+ `MXUsernameAvailability` represents the response returned when checking for username availability.
+ */
+@interface MXUsernameAvailability : MXJSONModel
+
+    /**
+     A flag to indicate that the username is available. This should always be true when the server replies with 200 OK.
+     */
+    @property (nonatomic) BOOL available;
+
+@end
+
 /**
  `MXAuthenticationSession` represents an authentication session returned by the home server.
  */
diff --git a/MatrixSDK/JSONModels/MXJSONModels.m b/MatrixSDK/JSONModels/MXJSONModels.m
@@ -150,6 +150,21 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary
 
 @end
 
+@implementation MXUsernameAvailability
+
++ (id)modelFromJSON:(NSDictionary *)JSONDictionary
+{
+    MXUsernameAvailability *availability = [[MXUsernameAvailability alloc] init];
+    if (availability)
+    {
+        MXJSONModelSetBoolean(availability.available, JSONDictionary[@"available"]);
+    }
+    
+    return availability;
+}
+
+@end
+
 @implementation MXAuthenticationSession
 
 + (id)modelFromJSON:(NSDictionary *)JSONDictionary
diff --git a/MatrixSDK/MXError.h b/MatrixSDK/MXError.h
@@ -32,6 +32,9 @@ FOUNDATION_EXPORT NSString *const kMXErrCodeStringNotJSON;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringNotFound;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringLimitExceeded;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringUserInUse;
+FOUNDATION_EXPORT NSString *const kMXErrCodeStringInvalidUsername;
+/// The resource being requested is reserved by an application service, or the application service making the request has not created the resource.
+FOUNDATION_EXPORT NSString *const kMXErrCodeStringExclusiveResource;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringRoomInUse;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringBadPagination;
 FOUNDATION_EXPORT NSString *const kMXErrCodeStringUnauthorized;
diff --git a/MatrixSDK/MXError.m b/MatrixSDK/MXError.m
@@ -29,6 +29,8 @@
 NSString *const kMXErrCodeStringNotFound                = @"M_NOT_FOUND";
 NSString *const kMXErrCodeStringLimitExceeded           = @"M_LIMIT_EXCEEDED";
 NSString *const kMXErrCodeStringUserInUse               = @"M_USER_IN_USE";
+NSString *const kMXErrCodeStringInvalidUsername         = @"M_INVALID_USERNAME";
+NSString *const kMXErrCodeStringExclusiveResource       = @"M_EXCLUSIVE";
 NSString *const kMXErrCodeStringRoomInUse               = @"M_ROOM_IN_USE";
 NSString *const kMXErrCodeStringBadPagination           = @"M_BAD_PAGINATION";
 NSString *const kMXErrCodeStringUnauthorized            = @"M_UNAUTHORIZED";
diff --git a/MatrixSDK/MXRestClient.h b/MatrixSDK/MXRestClient.h
@@ -325,13 +325,27 @@ NS_REFINED_FOR_SWIFT;
 /**
  Check whether a username is already in use.
 
- @username the user name to test (This value must not be nil).
+ @param username the user name to test (This value must not be nil).
  @param callback A block object called when the operation is completed.
 
  @return a MXHTTPOperation instance.
  */
 - (MXHTTPOperation*)isUserNameInUse:(NSString*)username
-                           callback:(void (^)(BOOL isUserNameInUse))callback NS_REFINED_FOR_SWIFT;
+                           callback:(void (^)(BOOL isUserNameInUse))callback NS_REFINED_FOR_SWIFT __deprecated_msg("Use isUsernameAvailable instead.");
+
+/**
+ Checks whether a username is available.
+
+ @param username the user name to test (This value must not be nil).
+ @param success A block object called when the operation succeeds. It provides the server response
+ as an MXUsernameAvailability instance.
+ @param failure A block object called when the operation fails.
+
+ @return a MXHTTPOperation instance.
+ */
+- (MXHTTPOperation*)isUsernameAvailable:(NSString*)username
+                                success:(void (^)(MXUsernameAvailability *availability))success
+                                failure:(void (^)(NSError *error))failure NS_REFINED_FOR_SWIFT;
 /**
  Get the list of register flows supported by the home server.
 
diff --git a/MatrixSDK/MXRestClient.m b/MatrixSDK/MXRestClient.m
@@ -597,6 +597,34 @@ - (MXHTTPOperation*)isUserNameInUse:(NSString*)username
     }];
 }
 
+- (MXHTTPOperation*)isUsernameAvailable:(NSString*)username
+                                success:(void (^)(MXUsernameAvailability *availability))success
+                                failure:(void (^)(NSError *error))failure
+{
+    NSDictionary* parameters = @{@"username": username};
+    
+    MXWeakify(self);
+    return [httpClient requestWithMethod:@"GET"
+                                    path:[NSString stringWithFormat:@"%@/register/available", apiPathPrefix]
+                              parameters:parameters
+                                 success:^(NSDictionary *JSONResponse) {
+                                     MXStrongifyAndReturnIfNil(self);
+
+                                     if (success)
+                                     {
+                                         __block MXUsernameAvailability *availability;
+                                         [self dispatchProcessing:^{
+                                             MXJSONModelSetMXJSONModel(availability, MXUsernameAvailability, JSONResponse);
+                                         } andCompletion:^{
+                                             success(availability);
+                                         }];
+                                     }
+                                 }
+                                 failure:^(NSError *error) {
+                                     [self dispatchFailure:error inBlock:failure];
+                                 }];
+}
+
 - (MXHTTPOperation*)getRegisterSession:(void (^)(MXAuthenticationSession *authSession))success
                                failure:(void (^)(NSError *error))failure
 {
diff --git a/MatrixSDK/Utils/MXHTTPClient.h b/MatrixSDK/Utils/MXHTTPClient.h
@@ -131,6 +131,11 @@ typedef NS_ENUM(NSUInteger, MXHTTPClientSSLPinningMode) {
  */
 @property (nonatomic, copy) MXHTTPClientTokenProviderHandler tokenProviderHandler;
 
+/**
+ Whether or not the client is able to send authenticated requests.
+ */
+@property (nonatomic, readonly) BOOL isAuthenticatedClient;
+
 #pragma mark - Public methods
 /**
  Create an instance to make requests to the server.
diff --git a/MatrixSDK/Utils/MXHTTPClient.m b/MatrixSDK/Utils/MXHTTPClient.m
@@ -79,7 +79,7 @@ @interface MXHTTPClient ()
 }
 
 /**
- The access token used for authenticated requests.
+ Whether or not the client should send authenticated requests by default.
  */
 @property (nonatomic) BOOL isAuthenticatedClient;
 
diff --git a/MatrixSDKTests/MXRestClientNoAuthAPITests.m b/MatrixSDKTests/MXRestClientNoAuthAPITests.m
@@ -168,6 +168,78 @@ - (void)testGetRegisterSession
     [self waitForExpectationsWithTimeout:10 handler:nil];
 }
 
+- (void)testUsernameAvailability
+{
+    XCTestExpectation *expectation = [self expectationWithDescription:@"asyncTest"];
+    
+    // Test with a random string as other tests may have already registered the test acounts
+    MXHTTPOperation *operation = [mxRestClient isUsernameAvailable:@"notyetregistered" success:^(MXUsernameAvailability *availability) {
+        
+        XCTAssertTrue(availability.available, @"The username should be available for registration.");
+        [expectation fulfill];
+        
+    } failure:^(NSError *error) {
+        
+        XCTFail(@"The request should not fail - the username should be available");
+        [expectation fulfill];
+        
+    }];
+    operation.maxNumberOfTries = 1;
+    
+    [self waitForExpectationsWithTimeout:10 handler:nil];
+}
+
+- (void)testUsernameAvailabilityForExistingUsername
+{
+    XCTestExpectation *expectation = [self expectationWithDescription:@"asyncTest"];
+    
+    [self createTestAccount:^{
+        MXHTTPOperation *operation = [mxRestClient isUsernameAvailable:MXTESTS_USER success:^(MXUsernameAvailability *availability) {
+            
+            XCTFail(@"The request should fail - the username should already be taken");
+            [expectation fulfill];
+            
+            } failure:^(NSError *error) {
+                
+                MXError *mxError = [[MXError alloc] initWithNSError:error];
+                
+                XCTAssertNotNil(mxError);
+                XCTAssertTrue([mxError.errcode isEqualToString:kMXErrCodeStringUserInUse], @"The error should indicate that the username is in use");
+                
+                [expectation fulfill];
+                
+            }];
+        operation.maxNumberOfTries = 1;
+    }];
+    
+    [self waitForExpectationsWithTimeout:10 handler:nil];
+}
+
+- (void)testUsernameAvailabilityForInvalidUsername
+{
+    XCTestExpectation *expectation = [self expectationWithDescription:@"asyncTest"];
+    
+    // Test a username that only has digits which is disallowed by the spec.
+    MXHTTPOperation *operation = [mxRestClient isUsernameAvailable:@"123456789" success:^(MXUsernameAvailability *availability) {
+        
+        XCTFail(@"The request should fail - the username should already be taken");
+        [expectation fulfill];
+        
+    } failure:^(NSError *error) {
+        
+        MXError *mxError = [[MXError alloc] initWithNSError:error];
+        
+        XCTAssertNotNil(mxError);
+        XCTAssertTrue([mxError.errcode isEqualToString:kMXErrCodeStringInvalidUsername], @"The error should indicate that the username is invalid");
+        
+        [expectation fulfill];
+        
+    }];
+    operation.maxNumberOfTries = 1;
+    
+    [self waitForExpectationsWithTimeout:10 handler:nil];
+}
+
 - (void)testRegisterWithDummyLoginType
 {
     XCTestExpectation *expectation = [self expectationWithDescription:@"asyncTest"];
diff --git a/changelog.d/5648.change b/changelog.d/5648.change
@@ -0,0 +1 @@
+Authentication: Add MXUsernameAvailability and isUsernameAvailable method on MXRestClient.

Original file line number	Diff line number	Diff line change
`@@ -32,15 +32,15 @@ + (instancetype)modelFromJSON:(NSDictionary *)JSONDictionary`
`32`	`32`
`33`	`33`	`if (loginFlow)`
`34`	`34`	`{`
`35`		`- NSArray *jsonIdentityProdivers;`
	`35`	`+ NSArray *jsonIdentityProviders;`
`36`	`36`
`37`		`- MXJSONModelSetArray(jsonIdentityProdivers, JSONDictionary[MXLoginSSOFlowIdentityProvidersKey]);`
	`37`	`+ MXJSONModelSetArray(jsonIdentityProviders, JSONDictionary[MXLoginSSOFlowIdentityProvidersKey]);`
`38`	`38`
`39`	`39`	`NSArray<MXLoginSSOIdentityProvider> identityProviders;`
`40`	`40`
`41`		`- if (jsonIdentityProdivers)`
	`41`	`+ if (jsonIdentityProviders)`
`42`	`42`	`{`
`43`		`- identityProviders = [MXLoginSSOIdentityProvider modelsFromJSON:jsonIdentityProdivers];`
	`43`	`+ identityProviders = [MXLoginSSOIdentityProvider modelsFromJSON:jsonIdentityProviders];`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`if (!identityProviders)`