Flutter plugin

This documentation contains information about the Flutter Plugin and integrating the Flutter Plugin with the Mobile SDK.

Get the plugin

The plugin and example application are available in the OneWelcome Identity Platform repository. Download the plugin and example application.

Get the Mobile SDK

To begin, ensure you have access to the Mobile SDK. To obtain credentials, navigate to the Customer Support Portal and submit a request for access.

Configure your project

Configure your native project for the Flutter Plugin to start work.

Project requirements

• Android: Minimum API level 24
• iOS: Minimum iOS version 15
• Flutter: Minimum Flutter version 1.12.0

Add the plugin to your project

To start using the plugin, you need to add the plugin to your project.

1. Open pubspec.yaml file in your project
2. Add dependency: Onegini: ^x.y.z.
3. Run the flutter pub get command.

Initialize Flutter Plugin

To initialize the Flutter Plugin, call the startApplication method.

Example code to initialize the plugin

await Onegini.instance
    .startApplication(
        twoStepCustomIdentityProviderIds: ["2-way-otp-api"],
        connectionTimeout: 5,
        readTimeout: 25,
        additionalResourceUrls: [])
    .catchError((error) {
        print("Initialization failed: " + error.message);
    });

Configure the Flutter SDK

The Flutter SDK is a wrapper for the Android and iOS SDKs. For this reason, the wrapper SDKs require access to the native SDKs to function, which can be done through the following steps:

1. Navigate to the Customer Support Portal and submit a request for access.
2. Use the SDK Configurator to configure the Flutter SDK on your application.

Integrate with Android

To integrate the Flutter Plugin with your Android project:

1. Modify the android/app/build.gradle android section:

   lintOptions {
       abortOnError false
   }
   

2. Add to the android -> defaultConfig section:

   minSdkVersion 23
   multiDexEnabled true
   

3. Add to android/build.gradle [allprojects.repositories]

   allprojects {
       repositories {
           google()
           jcenter()
           maven {
               url "https://thalescpliam.jfrog.io/artifactory/onegini-sdk"
               credentials {
                   username 'YOUR_USERNAME'
                   password 'YOUR_PASSWORD'
               }
           }
       }
   }
   

4. Set up the OneWelcome Identity Platform configuration. Generate a OneginiConfigModel and keystore.bks with the Mobile SDK Configurator.

5. The SDK introduced significant security improvements by providing two separate versions - production and develop.

   Production is a version with full security shields turned on. You won't be able to run the app on the emulator. The developer version has all of the security features turned off and is not meant to be used in production.

   To use the developer version, add the following variable in the gradle.properties:

   onegini_dev=true
   

   You are encouraged to use the new version of the SDK configurator 6.0.0 to automatically migrate the ClientConfigModel file into Kotlin and safely remove the SecurityController file.

   Caution

   Never release your app with the developer version of the SDK (with gradle property onegini_dev set). Doing so can result in a possible data breach and significantly decrease the security level of your app.

6. Modify android/app/src/main/AndroidManifest.xml. Add <intent-filter> to your MainActivity for listening browser redirects. Update scheme="oneginiexample" to use the scheme you generated using onegini-sdk-configurator.

   <intent-filter>
       <action android:name="android.intent.action.VIEW" />
       <category android:name="android.intent.category.DEFAULT" />
       <category android:name="android.intent.category.BROWSABLE" />
       <data android:scheme="oneginiexample" />
   </intent-filter>
   

   Note

   The Flutter Plugin uses deep links for communication between web pages and your app.

Integrate with iOS

iOS (>= 15.1):

Swift Package Manager

Before integrating SPM Package, run pod install.

1. Open a terminal and run:

   swift package-registry set --global https://thalescpliam.jfrog.io/artifactory/api/swift/swift-public swift package-registry login

2. Enter your artifactory token:

   Enter access token: {YOUR_TOKEN} Login successful. Credentials have been saved to the operating system's secure credential store. Registry configuration updated.

3. Open the iOS project in Xcode and select Pods.xcodeproj. Right-click and select Add Package Dependencies....

4. In the search bar, enter the Onegini SDK repository: OneWelcome.SDKSPM.

5. Choose the version 13.0.x with uptoNextMinorVersion of the SDK and click Add Package for target onegini.

6. Repeat steps 3 to 5 for <PROJECT>.xcodeproj for target <PROJECT>.

7. In the terminal, go to the app's directory and run:

   xcodebuild -resolvePackageDependencies

   Now your dependencies look like this:

   

CocoaPods

1. The Flutter Plugin is uploaded to the OneWelcome Identity Platform Artifactory repository. To let CocoaPods use an Artifactory repository, you need to install the cocoapods-art plugin.

   gem install cocoapods-art
   

2. The OneWelcome Identity Platform repository is not a public repository. You must provide credentials to access the repo. Create a file named .netrc in your Home folder (~/) and add the following contents to it:

   machine thalescpliam.jfrog.io
       login <username>
       password <password>
   

3. Add the OneWelcome Identity Platform CocoaPods repository to your machine:

   pod repo-art add onegini htps://thalescpliam.jfrog.io/artifactory/api/pods/cocoapods-public
   

4. To update the repository, you must manually perform the following update:

   pod repo-art update onegini
   

5. Add next to ios/Podfile (before app target):

   plugin 'cocoapods-art', :sources => [
       'onegini'
   ]
   

6. The SDK can detect whether the app works in debug mode or with a debugger attached. This feature is enabled by default. When debug mode detection is enabled and a debugger is detected, the iOS SDK does not allow you to execute any of the user-related flows and returns an error.

   To provide the best possible experience during iOS integration and security protection of your product, two types of SDK are provided: production (secure) and develop.

   SDK version	production	develop
   Debug detection	+	-
   Root detection	+	-
   Debug logs	-	+

   To use the develop version, add the following environment variable in the ios/Podfile:

   ENV['ONEGINI_DEV'] = 'true'
   

   In Case of SPM, use OneWelcome.SDKSPM-dev.

   Caution

   Never release your app with the developer version of the SDK (with environment variable ONEGINI_DEV set or OneWelcome.SDKSPM-dev as SPM). Doing so can result in a possible data breach and significantly decrease the security level of your app.

7. Run pod install.

Linking native iOS code

For iOS versions 12.0 and later, to link native code in the xCode project, execute:

cd ios && pod install

Flutter Plugin release notes

• Flutter Plugin release notes