flutteradal 1.0.3

  • Readme
  • Changelog
  • Example
  • Installing
  • 58

flutteradal #

Plugin to use ADAL from an on premise ADFS Server and Azure Active directory. Tested with 3.0 & Azure (27.07.2019).

Currently only iOS supported.

ios pod used https://github.com/AzureAD/azure-activedirectory-library-for-objc

How-to

IOS #

Set the minium deployment target of your project to 10.0 - This is a requirement set by the azure-activedirectory-library-for-objc https://github.com/AzureAD/azure-activedirectory-library-for-objc/issues/1435

Use the following commands in your flutter project after adding the package to your pubspec.yaml file. Flutter should do this alone but better save than sorry.

flutter packages get
cd /ios
pod init
pod install
pod update

FLUTTER #

Checkout the example for details and an implementation!

Create an AdalAuthContext. Call Flutteradal.adalLogin and pass your configuration data to it. The AdalAuthContext will hold the result.

On error and error will be set on AdalAuthContext.errorType

AdalAuthContext authContext;
authContext = await Flutteradal.adalLogin(
    authority: Config.authority,
    resourceUrl: Config.resourceUrl,
    clientId: Config.clientId,
    redirectUrl: Config.redirectUrl);

1.0.3 #

ADAL Version updated to 4.0.4.

1.0.2 #

ADAL Version updated to 4.0.3 which is nessecary to support IOS 13. Changes to the swift code that reflect the update.

1.0.1 #

Added test config to the example. Readme improved

1.0.0 #

Breaking change, update to the latest ADAL pod version (4.0) requires the minimum deployment target to be set to 10.0

0.1.2 #

License had the nickname, changed to real name and email

0.1.1 #

Github repo made public. Added the Url to the readme

0.1.0 #

Initial release - ios only

example/lib/main.dart

import 'package:flutter/material.dart';
import 'dart:async';

import 'package:flutter/services.dart';
import 'package:flutteradal/flutteradal.dart';
import 'package:flutteradal_example/config.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  String _platformVersion = 'Unknown';

  @override
  void initState() {
    super.initState();
    initPlatformState();
  }

  // Platform messages are asynchronous, so we initialize in an async method.
  Future<void> initPlatformState() async {
    String platformVersion;
    // Platform messages may fail, so we use a try/catch PlatformException.
    try {
      platformVersion = await Flutteradal.platformVersion;
    } on PlatformException {
      platformVersion = 'Failed to get platform version.';
    }

    // If the widget was removed from the tree while the asynchronous platform
    // message was in flight, we want to discard the reply rather than calling
    // setState to update our non-existent appearance.
    if (!mounted) return;

    setState(() {
      _platformVersion = platformVersion;
    });
  }

  AdalAuthContext authContext;
  test() async {
    authContext = await Flutteradal.adalLogin(
        authority: Config.authority,
        resourceUrl: Config.resourceUrl,
        clientId: Config.clientId,
        redirectUrl: Config.redirectUrl);
    setState(() {});
  }

  ifNotNullElseBlank(String value) {
    return value == "" || value == null ? "" : value;
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('Plugin example app'),
        ),
        body: SingleChildScrollView(
          child: Center(
            child: Column(
              children: <Widget>[
                Text('Running on: $_platformVersion\n'),
                RaisedButton(
                  child: Text("Hi"),
                  onPressed: () async => test(),
                ),
                this.authContext == null
                    ? Container()
                    : Card(
                        child: Column(
                          children: <Widget>[
                            this.authContext.isSuccess
                                ? Icon(Icons.check)
                                : Icon(Icons.error_outline),
                            Text(ifNotNullElseBlank(authContext?.errorType)),
                            Divider(
                              height: 15.0,
                              color: Colors.lightBlue,
                            ),
                            Text(ifNotNullElseBlank(
                                authContext?.expiresOn?.toLocal().toString())),
                            Divider(
                              height: 15.0,
                              color: Colors.lightBlue,
                            ),
                            Text(ifNotNullElseBlank(authContext?.refreshToken)),
                            Divider(
                              height: 15.0,
                              color: Colors.lightBlue,
                            ),
                            Text(ifNotNullElseBlank(authContext?.accessToken))
                          ],
                        ),
                      )
              ],
            ),
          ),
        ),
      ),
    );
  }
}

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  flutteradal: ^1.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter pub get

Alternatively, your editor might support flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:flutteradal/flutteradal.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
20
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
91
Overall:
Weighted score of the above. [more]
58
Learn more about scoring.

We analyzed this package on Jul 3, 2020, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.8.4
  • pana: 0.13.13
  • Flutter: 1.17.5

Analysis suggestions

Package does not support Flutter platform linux

Because of import path [package:flutteradal/flutteradal.dart] that declares support for platforms: android, ios

Package does not support Flutter platform macos

Because of import path [package:flutteradal/flutteradal.dart] that declares support for platforms: android, ios

Package does not support Flutter platform web

Because of import path [package:flutteradal/flutteradal.dart] that declares support for platforms: android, ios

Package does not support Flutter platform windows

Because of import path [package:flutteradal/flutteradal.dart] that declares support for platforms: android, ios

Package not compatible with SDK dart

because of import path [flutteradal] that is in a package requiring null.

Health issues and suggestions

Document public APIs. (-1 points)

17 out of 17 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Maintenance suggestions

The package description is too short. (-9 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.1.0 <3.0.0
flutter 0.0.0
Transitive dependencies
collection 1.14.12 1.14.13
meta 1.1.8
sky_engine 0.0.99
typed_data 1.1.6 1.2.0
vector_math 2.0.8
Dev dependencies
flutter_test