Flutter Single Sign-On SSO
Flutter JWT Single Sign-On (SSO) solution by miniOrange provides secure Single Sign-On access into Flutter application using a single set of login credentials. This is done using JSON Web Token (JWT) tokens and it can be easily integrated with Flutter built in any framework or language. You can enable social login for your users to get secure access to applications using any of their existing social providers such as Facebook, Twitter, Google, or LinkedIn.
With miniOrange Flutter SSO, you get:
- Seamless user login experience.
- Endless customizations to your login forms and pages.
- Simplified customer or user on-boarding.
Connect with External Source of Users
miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Azure AD, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Shibboleth, Ping, Okta, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more.
Follow the step-by-step guide given below for Flutter Single Sign-On (SSO):
Prerequisites
- Download the flutter_jwt_connector from here.
- Copy the path of the flutter_jwt_connector and add it as a package in the pubspec.yaml file of your project.
- Add jose:0.3.2 as a package.
dependencies:
flutter:
sdk: flutter
flutter_jwt_connector:
path: D:/sdk-and-connectors/flutter_jwt_connector
jose: ^0.3.2
- Install all the dependencies using
flutter pub get
1. Configure Flutter in miniOrange
- Go to Apps >> Add Application from the side menu.
![Flutter SSO: Configure and Add JWT application](/images/common-jwt/add-application.webp)
- Click on the JWT under Choose Application Type.
![Flutter SSO: Configure JWT app type](/images/common-jwt/dashboard-jwt.webp)
- In the next step, search for Flutter application from the list. If your application is not found, search for External / JWT App and you can set up your Application.
![Configure JWT application: Search Flutter JWT application](/images/common-jwt/search-jwt-app.webp)
- You can configure the following details in the application:
Custom App Name |
Enter the Application Name of your choice, and add a description if required. |
Redirect-URL |
Enter the Redirect-URL (i.e. the endpoint where you want to send/post your JWT token).
You can add multiple redirect URLs by separating them with a ‘;’. E.g. abc.com;xyz.com |
Primary Identity Provider (optional) |
Select your Identity Source from the dropdown. You can select miniOrange here as default IDP. |
![Flutter SSO: JWT app details](/images/common-jwt/jwt-app-details.webp)
- Click on Save to complete the configuration.
- Click on Edit in the select menu against your app.
![Flutter SSO: Edit app](/images/flutter/flutter-select-edit.webp)
- You can get further details about your recently added JWT application:
Client ID |
If your application provides its own client ID, you can configure it by clicking on the Customize button. |
App Secret |
You can find App Secret by clicking on the copy icon. This is used in the HS265 Signature
algorithm for generating the signature. |
Signature Algorithm |
Select your signature algorithm from the dropdown. |
Primary Identity Provider |
Select the default Identity Provider from the dropdown for the application. If not selected, users will see the default
login screen and can choose their own IDP. [Choose miniOrange in this case.] |
Redirect URL |
Given below is your app URL where you will receive your token.
RSA 256 : <your_app-login-url> (Here token will be added by the system)
HS256 : <app-login-url/?id_token=> |
![Flutter SSO: Search JWT application](/images/flutter/flutter-edit-app.webp)
- Scroll down to Endpoints >> Single Sign-On URL. Save this URL as you will need this in the following configuration.
![Flutter SSO: React Single Sign-On SSO endpoints url](/images/common-jwt/single-sign-on-url.webp)
- click on Save to save the configuration.
2. Configure the plugin in your application
- Select a component that will be responsible for verifying the JWT token most preferably the login component.
- Import the JWTBuilder class from the flutter_jwt_connector. From the path to which it was moved in step 1 of Prerequisites.
import 'package:flutter_jwt_connector/jwt_builder.dart';
- You can add a button on your login screen to redirect to the SSO URL. You can get this SSO URL from Step 1 of Configure your application in miniOrange.
ElevatedButton(onPressed: () => sso(), child: const Text("Login"))
sso() {
const url = '<YOUR SSO URL>'; //
"https://swapnilj.miniorange.in/moas/broker/login/jwt/21582?client_id=s9BIi073EBW
qyoAJ&redirect_uri=http://localhost:4000/"
html.window.open(url, "_self");
}
![Login button](/images/flutter/login-button.webp)
- On Clicking the SSO button the user will be redirected to the miniOrange portal for authentication Then the JWT token is returned to your application to the redirect URL you have set while adding your application in miniOrange. In the following steps, we will be verifying this token and retrieving the user details.
- Retrieve the id_token from the url and pass it down into the login widget
![Retrieve id token](/images/flutter/retrive-id-token.webp)
- You need to add your x509 certificate that you can get from Step 1 of configure your application in miniOrange.
- Now if the token is verified, the payload which consists of the User details can be saved in local storage or serialized into a User Class and the user now verified can be redirected to the home screen of your application.
3. Test SSO Configuration
Test SSO login to your Flutter account with miniOrange IdP:
4. Login Using Social Provider (Optional)
miniOrange provides user authentication from various external sources, which can be Directories (like ADFS, Microsoft Active Directory, Microsoft Entra ID, OpenLDAP, Google, AWS Cognito etc), Identity Providers (like Okta, Shibboleth, Ping, OneLogin, KeyCloak), Databases (like MySQL, Maria DB, PostgreSQL) and many more. You can configure your existing directory/user store or add users in miniOrange.
4.1. Configure Google Apps as OAuth 2.0 Provider in miniOrange.
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Providers >> Add Identity Provider.
![Flutter SSO: Add Identity Provider](/images/login-with-external-idp/select-add-identity-provider.webp)
- Select OAuth2.0
![Flutter SSO: Add OAuth2.0 Identity Provider](/images/login-with-external-idp/select-oauth.webp)
- Enter the following values:
IdP Name |
Custom Provider |
IdP Display Name |
Choose appropriate Name |
OAuth Authorize Endpoint |
https://{your-base-url}/as/authorization.oauth2 |
OAuth Access Token Endpoint |
https://{your-base-url}/as/authorization.oauth2 |
OAuth Get User Info Endpoint (optional) |
https://{your-base-url}/idp/userinfo.oauth2 |
Client ID |
From step 4.2 |
Client secret |
From step 4.2 |
Scope |
email |
4.2. Configuring miniOrange as Service Provider (SP) in Google Apps
- Go to https://console.developers.google.com/ and sign up/login.
- Click on Select Project to create a new Google Apps Project,you will see a popup with the list of all your projects.
![FlutterSSO: Creat Google Apps project](/images/googleapps/select-project-oauth-sso.webp)
- You can click on the New project button to create new project.
![FlutterSSO: Click on new project](/images/googleapps/click-on-new-project-oauth-sso.webp)
- Enter your Project name under the Project Name field and click on Create.
![FlutterSSO: Create New Project](/images/googleapps/create-project-oauth-sso.webp)
- Go to Navigation Menu >> APIs >> Services >> Credentials.
![FlutterSSO: Select Credentials](/images/googleapps/go-to-credentials-oauth-sso-1.webp)
- Click on Create Credentials button and then select OAuth Client ID from the options provided.
![FlutterSSO: Create Credentials](/images/googleapps/crentials-oauth-sso.webp)
- In case you are facing some warning saying that in order to create an OAuth Client ID, you must set a product name on consent screen (as shown in below image). Click on the Configure consent screen button.
![FlutterSSO: Configure consent screen](/images/googleapps/configure-consent-screen-oauth-sso.webp)
- Enter the required details such as App Name, User Support Email. and click on Save and Continue button.
![FlutterSSO: Enter App information](/images/googleapps/enter-app-information-oauth-sso.webp)
![FlutterSSO: Save all details](/images/googleapps/enter-all-details-and-save-oauth-sso.webp)
- Now for configuring scopes, click on Add or Remove the Scopes button.
![FlutterSSO: Add and Remove](/images/googleapps/add-remove-scope-oauth-sso.webp)
- Now, Select the Scopes to allow your project to access specific types of private user data from their Google Account and click on Save and Continue button.
![FlutterSSO: Update Selected Scope](/images/googleapps/update-the-scope-oauth-sso.webp)
- Go to the Credentials tab and click on Create Credentials button. Select Web Application from dropdown list to create new application.
![FlutterSSO: Select Web App Oauth](/images/googleapps/select-web-app-oauth-sso.webp)
- To get the Redirect URL:
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Provider.
![FlutterSSO: Select IdP](/images/login-with-external-idp/select-add-identity-provider.webp)
- Copy the Callback URL as Redirect URL required for next step.
![FlutterSSO: Select Oauth](/images/login-with-external-idp/select-oauth.webp)
- Enter the name you want for your Client ID under the name field and enter the Redirect/Callback URI and click on Create button.
![FlutterSSO: Create oauth client id](/images/googleapps/create-oauth-client-id-oauth-sso.webp)
- You will see a popup with the Client ID and Client Secret Copy your Client ID and Client Secret.
![FlutterSSO: Google client id client secret](/images/googleapps/google-sso-client-id-client-secret.webp)
- You have successfully completed your Google App OAuth Server side configurations.
4.1. Configure LinkedIn as OAuth 2.0 Provider in miniOrange.
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Providers >> Add Identity Provider.
![Flutter Social Login SSO: LinkedIn](/images/login-with-external-idp/select-add-identity-provider.webp)
- Select OAuth2.0
![FlutterSSO: Select Oauth LinkedIn](/images/login-with-external-idp/select-oauth.webp)
- Enter the following values:
IdP Name |
Custom Provider |
IdP Display Name |
Choose appropriate Name |
OAuth Authorize Endpoint |
https://www.linkedin.com/oauth/v2/authorization |
OAuth Access Token Endpoint |
https://www.linkedin.com/oauth/v2/accessToken |
OAuth Get User Info Endpoint (optional) |
https://api.linkedin.com/v2/me |
Client ID |
From step 4.2 |
Client secret |
From step 4.2 |
Scope |
r_emailaddress r_liteprofile |
4.2. Configure miniOrange as Service Provider (SP) in LinkedIn
- Go to https://www.linkedin.com/secure/developer?newapp= in order to create a new application. Click on Create Application button to create a new application.
![FlutterSSO LinkedIn: Create-application](/images/linkedin/oauth-sso-linkedin-create-app.webp)
- Enter the required details and click on the Create app button to save your changes.
![FlutterSSO LinkedIn: submit changes](/images/linkedin/oauth-sso-linkedin-fill-details.webp)
- Here you need to verify the provided page. If the verification of the page is not done, then SSO will not work.
![FlutterSSO: Verify App](/images/linkedin/verify-app.webp)
- Navigate to Products section and then select Sign in with LinkedIn.
![FlutterSSO LinkedIn: Products section](/images/linkedin/products-section-1.webp)
- Copy the Client Id and the Client Secret and save it in your miniOrange OAuth App configuration under Client Id and the Client Secret text fields respectively.
![Flutter SSO LinkedIn: Update-configuration](/images/linkedin/oauth-sso-linkedin-client-credentials.webp)
- To get the Redirect URL:
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Provider.
![FlutterSSO LinkedIn: Select IdP](/images/login-with-external-idp/select-add-identity-provider.webp)
- Copy the Callback URL as Redirect URL required for next step.
![FlutterSSO LinkedIn: Select Oauth](/images/login-with-external-idp/select-oauth.webp)
- Copy the Redirect/ Callback URl from above step and enter it under OAuth 2.0 -> Authorized Redirect URLs text box. Click on the Add button adjacent to the text box to save it. Finally, click on the Update button to save your configurations. (image on the next page).
![FlutterSSO: oauth sso linkedin redirect url](/images/linkedin/oauth-sso-linkedin-redirect-url.webp)
4.1. Configure Facebook as OAuth 2.0 Provider in miniOrange.
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Providers >> Add Identity Provider.
![Add Identity Provider](/images/login-with-external-idp/select-add-identity-provider.webp)
- Select OAuth2.0
![Flutter Social Login SSO: Facebook](/images/login-with-external-idp/select-oauth.webp)
- Enter the following values:
IdP Name |
Facebook |
IdP Display Name |
Choose appropriate Name |
Client ID |
From step 4.2 |
Client secret |
From step 4.2 |
Scope |
public_profile email |
4.2. Configure miniOrange as Service Provider (SP) in Facebook
- First of all, Login/ Signup in Facebook developer console at https://developers.facebook.com/
![FlutterSSO Facebook: SSO developer console](/images/facebook/facebook-sso-developer-console.webp)
- Go to My apps.
![FlutterSSO: Facebook SSO add new app](/images/facebook/oauth-sso-facebook-goto-myapp.webp)
- Click on Create app to create a new app.
![FlutterSSO: Facebook SSO add new app](/images/facebook/create-app-button.webp)
- Select what your app is going to work for.
![FlutterSSO: Facebook SSO add new app](/images/facebook/oauth-sso-facebook-select-option.webp)
![FlutterSSO: Facebook SSO add new app](/images/facebook/oauth-sso-facebook-add-details.webp)
- Enter the required details and click on create app.
![FlutterSSO Facebook: Fill Details](/images/facebook/facebook-sso-fill-details.webp)
- Complete the security check and click on Submit button.
![FlutterSSO: Facebook Login](/images/facebook/login-page.webp)
- Select Facebook Login by clicking on the set up button .
![Flutter Social Login SSO: Facebook: SSO login setup](/images/facebook/select-facebook-login.webp)
- Select Facebook Login >> Settings under Products option in the navigation bar.
![Flutter Social Login SSO: Facebook: SSO login setting](/images/facebook/click-on-settings.webp)
- To get the Redirect URL:
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Provider.
![Flutter Social Login SSO: Facebook](/images/login-with-external-idp/select-add-identity-provider.webp)
- Copy the Callback URL as Redirect URL required for next step.
![Flutter Social Login SSO: Facebook](/images/login-with-external-idp/select-oauth.webp)
- Under Client OAuth Settings, enter the Callback/Redirect URL in the Valid OAuth Redirect URIs field. Click on the Save button to save your configurations.
Most importantly, your Callback/Redirect URI should be https and not http. It is mandatory while configuring Facebook as an OAuth Server.
![Flutter Social Login SSO: Facebook: SSO client oauth setting](/images/facebook/redirect-url-for-miniorange.webp)
- Go to Settings -> Basic to view your App Id and App Secret (Refer to the image below).
![Flutter Social Login SSO: Facebook: SSO client oauth basic setting](/images/facebook/client-id-secret-for-idp.webp)
- You have successfully completed your Facebook App OAuth Server side configurations.
4.1. Configure Apple Apps as OAuth 2.0 Provider in miniOrange.
- Go to miniOrange Admin Console.
- From the left navigation bar select Identity Providers >> Add Identity Provider.
![Add Identity Provider](/images/login-with-external-idp/select-add-identity-provider.webp)
- Select OAuth2.0
![Flutter Social Login SSO: Apple](/images/apple-sso/select-oauth-2.0.webp)
- Fill in the details shown in the below image.
![Flutter Social Login SSO: Apple](/images/apple-sso/apple-oauth-app-details.webp)
IDP Name: |
Apple ID |
OAuth Authorize Endpoint |
https://appleid.apple.com/auth/authorize?response_mode=form_post |
OAuth Access Token Endpoint* |
https://appleid.apple.com/auth/token |
Client ID* |
{Your service id} e.g. com.john.serviceid |
Client Secret* |
eyJraWQiOiJCOTJQUDg1VUw4IiwiYWxnIjoiRVMyNTYifQ.eyJpc3MiOiJFW.... |
- Click Save.
4.2. Configure miniOrange as Service Provider (SP) in Apple Apps
- Go to https://developer.apple.com click on Account and Login with your Apple developer account.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-login.webp)
- Click on Certificates, Identifiers and Profiles in Apple Account.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-Profiles.webp)
- In the left menu Click on Identifiers and after that click on the Plus Icon(blue color). Click on Continue for the next 2 pages of Apple Account.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-user-Identifiers.webp)
- Enter Description and Bundle ID for the App ID. (The Bundle ID is best when it’s a reverse-dns style string.)
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-description.webp)
- In the Capabilities section scroll down and select sign up with apple. Click on Edit and select Enable as a primary App Id and click on Save. Click on Continue and then click on Register.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-capabilities.webp)
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-user-primary-app.webp)
- In the right corner click on Continue and after that Register button.
- Again click the Plus icon( blue color). Select Service IDs and click on Continue.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-plusicon.webp)
- Enter Description and Identifier( Identifier would be your client id - Copy this id and Paste in the above field of Client ID). and click on the Continue and after that Register button.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-clientid.webp)
- Click Keys from the left menu.Click on the Plus icon to register a new key.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-new-key.webp)
- Give your Key a name, and select Sign In with Apple and click on Configure button
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-key.webp)
- Select your Primary Id and click on the Save button and after that at the right corner click on Continue and Register button.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-register.webp)
- Click on the Download button once the key is downloaded click on the Done button.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-download.webp)
- In the left menu click on Identifiers.
- At the right top click on App IDs.
- Select Service IDs from the drop-down menu.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-user-ids.webp)
- Select your Service Id from the List.
- Select Sign In with Apple and click on Configure button<./li>
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-app-login-configure.webp)
- Select the Primary App Id from the drop-down, and Enter the Domain and Redirect URL in Domains and Subdomains and Return URLs respectively and click on the Next button (You will get the Domain name and Redirect URL from miniOrange dashboard).
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-user-redirect-url.webp)
- Verify the details and click on the Done button. After that at the right corner click on the Continue button.
- Copy the Identifier value and click on the Save button.
![Flutter Social Login SSO: Apple](/images/apple-sso/wp-social-login-apple-app-id-secret.webp)
- Enter the Identifier value in the App Id field and copy the downloaded key value in App secret field of the Apple Login instruction miniOrange plugin.
Generating Secret Key
- Download the Ruby installer from the following link https://rubyinstaller.org/downloads/ and then install it.
- Search for the Start command prompt with ruby open the ruby command prompt and install the JWT gem by running the following command on the command line: gem install jwt.
- Copy the below code in a file and save the file with the .rb extension. Keep this .rb file and downloaded .p8 file in the same folder.
- Enter the name of downloaded file example= "key.P8", key_id , client_id, team_id in the code
require 'jwt'
key_file = 'key.P8'
team_id = ''
client_id = ''
key_id = ''
ecdsa_key = OpenSSL::PKey::EC.new IO.read key_file
headers = {
'kid' => key_id
}
claims = {
'iss' => team_id,
'iat' => Time.now.to_i,
'exp' => Time.now.to_i + 86400*180,
'aud' => 'https://appleid.apple.com',
'sub' => client_id,
}
token = JWT.encode claims, ecdsa_key, 'ES256', headers
puts token
- Open Ruby command prompt and run the above code using the following command: ruby filename.rb.
- You will be provided with your Client secret key. Copy and save the secret key; you will need it to configure Apple ID in miniOrange Dashboard.
![Flutter Social Login SSO: Apple](/images/apple-sso/generate-secret-key.webp)
External References