simple_auth_flutter

Description:

simple auth flutter

[](https://gitter.im/simple_auth/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
Most apps need to make API calls. Every API needs authentication, yet no developer wants to deal with authentication. Simple Auth embeds authentication into the API so you dont need to deal with it.
This is a Flutter adapter for the port of Clancey.SimpleAuth to Dart, (simple_auth)[https://github.com/Clancey/simple_auth]
The network/api part including the generator was based off of Chopper by Hadrien Lejard
iOS:
Android:
Providers #
Current Built in Providers #

Azure Active Directory
Amazon
Dropbox
Facebook
Github
Google
Instagram
Linked In
Microsoft Live Connect
Keycloak
And of course any standard OAuth2/Basic Auth server.

Usage #
var api = new simpleAuth.GoogleApi(
"google", "client_id",clientSecret: "clientSecret",
scopes: [
"https://www.googleapis.com/auth/userinfo.email",
"https://www.googleapis.com/auth/userinfo.profile"
]);
var request = new Request(HttpMethod.Get, "https://www.googleapis.com/oauth2/v1/userinfo?alt=json");
var userInfo = await api.send<UserInfo>(request);
copied to clipboard
That's it! If the user is not logged in, they will automatically be prompted. If their credentials are cached from a previous session, the api call proceeds! Expired tokens even automatically refresh.
Flutter Setup #
Import package:simple_auth/simple_auth.dart and package:simple_auth_flutter/simple_auth_flutter.dart
Call SimpleAuthFlutter.init(); in your Main.Dart. Now simple_auth can automatically present your login UI.
Redirect #
Google requires the following redirect: com.googleusercontent.apps.YOUR_CLIENT_ID
Simple Auth by default uses SFSafari on iOS and Chrome Tabs on Android.
This means normal http redirects cannot work. You will need to register a custom scheme for your app as a redirect. For most providers, you can create whatever you want. i.e. com.myapp.foo:/redirct
Android Manifest #
you would then add the following to your Android manifest
<activity android:name="clancey.simpleauth.simpleauthflutter.SimpleAuthCallbackActivity" >
<intent-filter android:label="simple_auth">
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
<data android:scheme="com.myapp.foo" />
</intent-filter>
</activity>
copied to clipboard
iOS #
on iOS you need the following in your app delegate.
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation{
return [SimpleAuthFlutterPlugin checkUrl:url];
}

copied to clipboard
For iOS 11 and higher, you don't need to do anything else. On older iOS versions the following is required in the info.plist
<key>CFBundleURLTypes</key>
<array>
<dict>
<key>CFBundleURLSchemes</key>
<array>
<string>com.myapp.foo</string>
</array>
<key>CFBundleURLName</key>
<string>myappredirect</string>
</dict>
</array>

copied to clipboard
Note, if you want to avoid Apples mandatory user consent dialog



"foo" Wants to use "bar.com" to Sign In




This allows the app and website to share information about you.



add the lines above and set FooAuthenticator.useSSO = false; which will not use SFAuthenticationSession. This is the default behavior for the Keycloak provider.
Serialization #
Json objects will automatically serialize if you conform to JsonSerializable
If you use the generator and you objects have the factory factory JsonSerializable.fromJson(Map<String, dynamic> json) your api calls will automatically Serialize/Deserialize
Or you can pass your own Converter to the api and handle conversion yourself.
Generator #
Dart #
pub run build_runner build
copied to clipboard
flutter #
flutter packages pub run build_runner build
copied to clipboard
Add the following to your pubspec.yaml
dev_dependencies:
simple_auth_generator:
build_runner: ^0.8.0
copied to clipboard
The Generator is not required, however it will make things magical.
@GoogleApiDeclaration("GoogleTestApi","client_id",clientSecret: "client_secret", scopes: ["TestScope", "Scope2"])
abstract class GoogleTestDefinition {
@Get(url: "https://www.googleapis.com/oauth2/v1/userinfo?alt=json")
Future<Response<GoogleUser>> getCurrentUserInfo();
}

copied to clipboard
will generate a new Api for you that is easy to use!
var api = new GoogleTestApi("google");
var user = await api.getCurrentUserInfo();
copied to clipboard
For more examples, check out the example project
Contributor #

Thanks for the logo made by @iqbalhood

TODO #

Add more documentation
Add native flutter providers for google