A Flutter OAuth package for performing user authentication for your apps.

Last update: Dec 9, 2022

Related tags

Overview

Flutter OAuth

A Flutter OAuth package for performing user authentication for your apps.

I've tested this with a small collection of APIs (Buffer, Strava, Unsplash and GitHub). If there is an issue with an API you are trying to work with, please file an issue :)

Authorizing an application

Performing authorization for an API is straight forward using this library. In most cases you will just be able to use the following approach:

final OAuth flutterOAuth = new FlutterOAuth(new Config(
    "https://unsplash.com/oauth/authorize",
    "https://unsplash.com/oauth/token",
    "YOUR_CLIENT_ID",
    "YOUR_CLIENT_SECRET",
    "http://localhost:8080",
    "code"));

This allows you to pass in an Authorization URL, Token request URL, Client ID, Client Secret, Redirect URL and the response type. This should satisfy most requests, but if not then you can pass in other optional parameters for:

contentType - This allows you to change the content type for the request. For example, for Spotify API authorization you need to use "application/x-www-form-urlencoded"

final OAuth flutterOAuth = new FlutterOAuth(new Config(
    ...,
    contentType: "application/x-www-form-urlencoded"));

parameters - Add your own parameters that this library may not support out-of-the-box. For example, with the GitHub API you can send a state string and scopes to gain authorization for

Map<String, String> customParameters = {"state": "SOME_RANDOM_SECURE_STRING", "scope": "public_repo"};

final OAuth flutterOAuth = new FlutterOAuth(new Config(
    ...,
    parameters: customParameters));

headers - Some APIs require you to send custom headers, such as an Authorization Header. Use this parameter if you require this

Map<String, String> headers = {"Authorization": "Basic SOME_BASE_64_STRING"};

final OAuth flutterOAuth = new FlutterOAuth(new Config(
    ...,
    headers: headers));

Then once you have an OAuth instance, you can simply call the performAuthorization() method like so to retrieve a Token instance:

Token token = await flutterOAuth.performAuthorization();
String accessToken = token.accessToken;

Installing

Add the following you your pubspec.yaml dependancies:

dependencies:
  flutter_oauth: "^0.0.1"

Thanks to

Kevin Seqaud for his awesome blog post on Flutter OAuth https://medium.com/@segaud.kevin/facebook-oauth-login-flow-with-flutter-9adb717c9f2e

The author, Hadrien Lejard, behind the:

The Gitter-Dart repo, where a lot of this library was influenced

and the Flutter Webview plugin, which this library uses

Comments

Need to upgrade flutter webview plugin dependency

I'm getting errors related to a return type of Future within the flutter_webview_plugin. I checked that repo and those response types have been changed to a generic Future without the . I think you need to update the dependency number to get the latest flutter_webview_plugin.

opened by matthew-carroll 6
Does not work with current Flutter version (not compatible with Dart2)

[VERBOSE-2:dart_error.cc(16)] Unhandled exception: type 'Future' is not a subtype of type 'Future' #0 FlutterWebviewPlugin.close (package:flutter_webview_plugin/flutter_webview_plugin.dart:73:36) #1 FlutterOAuth.requestCode (package:flutter_oauth/lib/flutter_auth.dart:26:21) #2 OAuth.performAuthorization (package:flutter_oauth/lib/oauth.dart:49:31)

opened by fvisticot 3
Fixed WebView plugin, updated to newest version

Currently, Flutter throws an error about expecting Future, but receiving Future. This fixed the error from occurring, but did not show me the WebView plugin (Which is likely my inexperience with API's)

opened by tristanwilson111 2
get state value

After succussfully get auth code how I can get state value for sending own server.

var result = await appAuth.authorize( AuthorizationTokenRequest( '$clientId', '$redirectUri', discoveryUrl: finalUrl, serviceConfiguration: AuthorizationServiceConfiguration(finalUrl, ""), scopes: ['profile'], ), );

opened by abroresonaliev 0
Faceit OAuth

Hi, I'm trying to use Faceit's OAuth Api with your example app but every time I hit authorize it tries to open this url: http://auth-api.team-platform/v1/oauth/login?client_id=CLIENT_ID&response_type=code&redirect_popup=false

Faceit's auth url is: http://api.faceit.com/auth/v1/oauth/authenticate and the token url: http://api.faceit.com/auth/v1/oauth/token

opened by fantasia-y 0
Cann't use it on Dart 2.5.0

Running "flutter pub get" in smart_parking_flutter... The current Dart SDK version is 2.5.0.

Because smart_parking_flutter depends on flutter_oauth any which requires SDK version >=1.8.0 <2.0.0, version solving failed. pub get failed (1) Process finished with exit code 1

opened by Wassmd 1
Configurable local callback server

Hi,

API providers are sometimes very restrictive about redirect uris. Please provide a way to customize the server parameters so that it can match every callback uri. Especially the port number.

opened by ludoo0d0a 2

Doesnt work with latest flutter

Error message is:

The current Dart SDK version is 2.1.0-dev.5.0.flutter-a2eb050044.

Because flutter_app_delete depends on flutter_oauth any which requires SDK version >=1.8.0 <2.0.0, version solving failed.

opened by mrgithub 6

type 'Future' is not a subtype of type 'Future'
I tried to create a very basic example. I just created a method like this and called it: `Future _performOAuthLogin(String client_id, String client_secret) { final OAuth flutterOAuth = new FlutterOAuth(new Config( "https://localhost:8888/oauth/authorize", "https://localhost:8888/oauth/token", client_id, client_secret, "http://localhost:8080", "code"));

return flutterOAuth.performAuthorization();

}`

This code snippit leads to the following exception: [VERBOSE-2:dart_error.cc(16)] Unhandled exception: type 'Future<dynamic>' is not a subtype of type 'Future<Null>' #0 FlutterWebviewPlugin.close (package:flutter_webview_plugin/flutter_webview_plugin.dart:73:36) #1 FlutterOAuth.requestCode (package:flutter_oauth/lib/flutter_auth.dart:26:21) <asynchronous suspension> #2 OAuth.performAuthorization (package:flutter_oauth/lib/oauth.dart:49:31) <asynchronous suspension>

Am i doing something wrong?
opened by Jannis87 2