Support multiple SSO Identity Providers (MSC2858) #965
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // | ||
| // Copyright 2020 The Matrix.org Foundation C.I.C | ||
| // | ||
| // 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 <Foundation/Foundation.h> | ||
| #import "MXJSONModels.h" | ||
| #import "MXLoginSSOIdentityProvider.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| extern NSString *const MXLoginSSOFlowIdentityProvidersKey; | ||
|
|
||
| /** | ||
| `MXLoginSSOFlow` represents a SSO login or a register flow supported by the home server (See MSC2858 https://github.com/matrix-org/matrix-doc/pull/2858). | ||
| */ | ||
| @interface MXLoginSSOFlow : MXLoginFlow | ||
|
There was a problem hiding this comment. I'm not very comfortable with the existence of this class and deciding that a flow is SSO or not by class check. Why don't we reuse There was a problem hiding this comment. I made the same as Web implementation only expose relevant properties for dedicated flow. It's not a really good idea either to expose a lot of properties that can be nil or not and used in only one case. There was a problem hiding this comment. There was a problem hiding this comment. Ok, let's continue as is then. thanks for the explanation. |
||
|
|
||
| /** | ||
| List of all SSO Identity Providers supported | ||
| */ | ||
| @property (nonatomic, readonly) NSArray<MXLoginSSOIdentityProvider*> *identityProviders; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| // | ||
| // Copyright 2020 The Matrix.org Foundation C.I.C | ||
| // | ||
| // 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 "MXLoginSSOFlow.h" | ||
|
|
||
| NSString *const MXLoginSSOFlowIdentityProvidersKey = @"identity_providers"; | ||
|
|
||
| @interface MXLoginSSOFlow() | ||
|
|
||
| @property (nonatomic, readwrite) NSArray<MXLoginSSOIdentityProvider*> *identityProviders; | ||
|
|
||
| @end | ||
|
|
||
| @implementation MXLoginSSOFlow | ||
|
|
||
| + (id)modelFromJSON:(NSDictionary *)JSONDictionary | ||
| { | ||
| MXLoginSSOFlow *loginFlow = [MXLoginSSOFlow new]; | ||
| if (loginFlow) | ||
| { | ||
| MXJSONModelSetString(loginFlow.type, JSONDictionary[@"type"]); | ||
| MXJSONModelSetArray(loginFlow.stages, JSONDictionary[@"stages"]); | ||
|
||
|
|
||
| NSArray *jsonIdentityProdivers; | ||
|
|
||
| MXJSONModelSetArray(jsonIdentityProdivers, JSONDictionary[MXLoginSSOFlowIdentityProvidersKey]); | ||
|
|
||
| NSArray<MXLoginSSOIdentityProvider*> *identityProviders; | ||
|
|
||
| if (jsonIdentityProdivers) | ||
| { | ||
| identityProviders = [MXLoginSSOIdentityProvider modelsFromJSON:jsonIdentityProdivers]; | ||
| } | ||
|
|
||
| if (!identityProviders) | ||
| { | ||
| identityProviders = [NSArray new]; | ||
| } | ||
|
|
||
| loginFlow.identityProviders = identityProviders; | ||
|
|
||
| } | ||
|
|
||
| return loginFlow; | ||
| } | ||
|
|
||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| // | ||
| // Copyright 2020 The Matrix.org Foundation C.I.C | ||
| // | ||
| // 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 <Foundation/Foundation.h> | ||
| #import "MXJSONModel.h" | ||
|
|
||
| NS_ASSUME_NONNULL_BEGIN | ||
|
|
||
| /** | ||
| `MXLoginSSOIdentityProvider` represents a SSO Identity Provider as described in MSC2858 (See https://github.com/matrix-org/matrix-doc/pull/2858) | ||
| */ | ||
| @interface MXLoginSSOIdentityProvider : MXJSONModel | ||
|
|
||
| /** | ||
| The identifier field (id field in JSON) is the Identity Provider identifier used for the SSO Web page redirection `/login/sso/redirect/{idp_id}`. | ||
| */ | ||
| @property (nonatomic, readonly) NSString *identifier; | ||
|
|
||
| /** | ||
| The name field is a human readable string intended to be printed by the client. | ||
| */ | ||
| @property (nonatomic, readonly) NSString *name; | ||
|
|
||
| /** | ||
| The icon field is an optional field that points to an icon representing the identity provider. If present then it must be an HTTPS URL to an image resource. | ||
| */ | ||
| @property (nonatomic, readonly, nullable) NSString *icon; | ||
|
|
||
| @end | ||
|
|
||
| NS_ASSUME_NONNULL_END |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| // | ||
| // Copyright 2020 The Matrix.org Foundation C.I.C | ||
| // | ||
| // 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 "MXLoginSSOIdentityProvider.h" | ||
|
|
||
| @interface MXLoginSSOIdentityProvider() | ||
|
|
||
| @property (nonatomic, readwrite) NSString *identifier; | ||
| @property (nonatomic, readwrite) NSString *name; | ||
| @property (nonatomic, readwrite, nullable) NSString *icon; | ||
|
|
||
| @end | ||
|
|
||
| @implementation MXLoginSSOIdentityProvider | ||
|
|
||
| + (id)modelFromJSON:(NSDictionary *)JSONDictionary | ||
| { | ||
| NSString *identifier; | ||
| NSString *name; | ||
|
|
||
| MXJSONModelSetString(identifier, JSONDictionary[@"id"]); | ||
| MXJSONModelSetString(name, JSONDictionary[@"name"]); | ||
|
|
||
| MXLoginSSOIdentityProvider *identityProvider = [MXLoginSSOIdentityProvider new]; | ||
|
|
||
| if (identityProvider && identifier && name) | ||
|
||
| { | ||
| identityProvider.identifier = identifier; | ||
| identityProvider.name = name; | ||
| MXJSONModelSetString(identityProvider.icon, JSONDictionary[@"icon"]); | ||
| } | ||
|
|
||
| return identityProvider; | ||
| } | ||
|
|
||
| @end | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We usually use the API changes section for api breaks.
It will be annoying if we start to describe every new api here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree this