Generic OAuth 2

@capacitor-community/generic-oauth2

Generic Capacitor OAuth 2 client plugin.

Introduction

This is a generic OAuth 2 client plugin. It lets you configure the oauth parameters yourself instead of using SDKs.
Therefore, it is usable with various providers. See identity providers the community has already
used this plugin with.

Installation

``bash
npm install @capacitor-community/generic-oauth2
npx cap sync
`

Versions

| Plugin | For Capacitor | Docs | Notes |
|--------|---------------|---------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| 7.x | 7.x.x | README | Xcode 16.0+ required! |
| 6.x | 6.x.x | README | Breaking changes. As of this version the changelog will be available in the Releases tab in GitHub. XCode 15.0 needs this version |
| 5.x | 5.x.x | README | Breaking changes see Changelog. XCode 14.1 needs this version |

Supported flows

See the excellent article about OAuth2 response type combinations.

https://medium.com/@darutk/diagrams-of-all-the-openid-connect-flows-6968e3990660

The plugin on the other will behave differently depending on the existence of certain config parameters:

These parameters are:

- accessTokenEndpoint
- resourceUrl

e.g.

1. If responseType=code, pkceDisable=true and accessTokenEndpoint is missing the authorizationCode will be
resolve along with the whole authorization response.
This only works for the Web and Android. On iOS the used lib does not allows to cancel after the authorization
request see #13.

2. If you just need the id_token JWT you have to set accessTokenEndpoint and resourceUrl to null.

$3

These flows are already working and were tested by me.

#### Implicit flow

`
responseType: "token"
`

#### Code flow + PKCE

`
...
responseType: "code"
pkceEnabled: true
...
`

Supported on Web with the new method redirectFlowCodeListener which should be called on your app init process
so it watches for the URL queryString code to generate an access_token correctly.

Please be aware that some providers (OneDrive, Auth0) allow Code Flow + PKCE only for native apps. Web apps have to
use implicit flow.

$3

For security reasons this plugin does/will not support Code Flow without PKCE.

That would include storing your client secret in client code which is highly insecure and not recommended.
That flow should only be used on the backend (server).

Configuration

$3

`typescript
import {GenericOAuth2} from '@capacitor-community/generic-oauth2';

@Component({
template:
'Login with OAuth' +
'Refresh token',
})
export class SignupComponent {
accessToken: string;
refreshToken: string;

onOAuthBtnClick() {
GenericOAuth2.authenticate(oauth2Options)
.then(response => {
this.accessToken = response['access_token'];
this.refreshToken = response['refresh_token'];

// only if you include a resourceUrl protected user values are included in the response!
let oauthUserId = response['id'];
let name = response['name'];

// go to backend
})
.catch(reason => {
console.error('OAuth rejected', reason);
});
}

// Refreshing tokens only works on iOS/Android for now
onOAuthRefreshBtnClick() {
if (!this.refreshToken) {
console.error('No refresh token found. Log in with OAuth first.');
}

GenericOAuth2.refreshToken(oauth2RefreshOptions)
.then(response => {
this.accessToken = response['access_token'];
// Don't forget to store the new refresh token as well!
this.refreshToken = response['refresh_token'];
// Go to backend
})
.catch(reason => {
console.error('Refreshing token failed', reason);
});
}
}
`

$3

See the oauth2Options and oauth2RefreshOptions interfaces
at https://github.com/capacitor-community/generic-oauth2/blob/main/src/definitions.ts for details.

Example:

`
{
authorizationBaseUrl: "https://accounts.google.com/o/oauth2/auth",
accessTokenEndpoint: "https://www.googleapis.com/oauth2/v4/token",
scope: "email profile",
resourceUrl: "https://www.googleapis.com/userinfo/v2/me",
logsEnabled: true,
web: {
appId: environment.oauthAppId.google.web,
responseType: "token", // implicit flow
accessTokenEndpoint: "", // clear the tokenEndpoint as we know that implicit flow gets the accessToken from the authorizationRequest
redirectUrl: "http://localhost:4200",
windowOptions: "height=600,left=0,top=0"
},
android: {
appId: environment.oauthAppId.google.android,
responseType: "code", // if you configured a android app in google dev console the value must be "code"
redirectUrl: "com.companyname.appname:/" // package name from google dev console
},
ios: {
appId: environment.oauthAppId.google.ios,
responseType: "code", // if you configured a ios app in google dev console the value must be "code"
redirectUrl: "com.companyname.appname:/" // Bundle ID from google dev console
}
}
`

#### authenticate()

Overrideable Base Parameter

These parameters are overrideable in every platform

| parameter | default | required | description | since |
|---------------------------|---------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------|
| appId | | yes | aka clientId, serviceId, ... | |
| authorizationBaseUrl | | yes | | |
| responseType | | yes | | |
| redirectUrl | | yes | | 2.0.0 |
| accessTokenEndpoint | | | If empty the authorization response incl code is returned. Known issue: Not on iOS! | |
| resourceUrl | | | If empty the tokens are return instead. If you need just the id_token you have to set both accessTokenEndpoint and resourceUrl to null or empty . | |
| additionalResourceHeaders | | | Additional headers for the resource request | 3.0.0 |
| pkceEnabled | false | | Enable PKCE if you need it. Note: On iOS because of #111 boolean values are not overwritten. You have to explicitly define the param in the subsection. | |
| logsEnabled | false | | Enable extensive logging. All plugin outputs are prefixed with I/Capacitor/GenericOAuth2Plugin: across all platforms. Note: On iOS because of #111 boolean values are not overwritten. You have to explicitly define the param in the subsection. | 3.0.0 |
| scope | | | | |
| state | | | The plugin always uses a state.
If you don't provide one we generate it. | |
| additionalParameters | | | Additional parameters for anything you might miss, like none, response_mode.

Just create a key value pair.
{ "key1": "value", "key2": "value, "response_mode": "value"} | |

Platform Web

| parameter | default | required | description | since |
|------------------------|----------|----------|-------------------------------------------------------------------------------------------------|-------|
| windowOptions | | | e.g. width=500,height=600,left=0,top=0 | |
| windowTarget | _blank | | | |
| windowReplace | | | | 3.0.0 |
| sendCacheControlHeader | true | | Whether to send the cache control header with the token request, unsupported by some providers. | 6.1.0 |

Platform Android

| parameter | default | required | description | since |
|------------------------------|---------|----------|--------------------------------------------------------------------------------------------------------------------------|-------|
| customHandlerClass | | | Provide a class name implementing com.getcapacitor.community.genericoauth2.handler.OAuth2CustomHandler | |
| handleResultOnNewIntent | false | | Alternative to handle the activity result. The onNewIntent method is only call if the App was killed while logging in. | |
| handleResultOnActivityResult | true | | | |

Platform iOS

| parameter | default | required | description | since |
|--------------------|---------|----------|------------------------------------------------------------------------------------------------|-------|
| customHandlerClass | | | Provide a class name implementing CapacitorCommunityGenericOauth2.OAuth2CustomHandler | |
| siwaUseScope | | | SiWA default scope is name email if you want to use the configured one set this param true | 2.1.0 |

#### logout()

The existing logout() method has some issues and is not currently functional.
See Issue #97 for possible workarounds.

#### refreshToken()

| parameter | default | required | description | since |
|---------------------|---------|----------|------------------------------|-------|
| appId | | yes | aka clientId, serviceId, ... | |
| accessTokenEndpoint | | yes | | |
| refreshToken | | yes | | |
| scope | | | | |

$3

#### authenticate()

- ERR_PARAM_NO_APP_ID ... The appId / clientId is missing. (web, android, ios)
- ERR_PARAM_NO_AUTHORIZATION_BASE_URL ... The authorization base url is missing. (web, android, ios)
- ERR_PARAM_NO_RESPONSE_TYPE ... The response type is missing. (web, android, ios)
- ERR_PARAM_NO_REDIRECT_URL ... The redirect url is missing. (web, android, ios)
- ERR_STATES_NOT_MATCH ... The state included in the authorization code request does not match the one in the redirect.
Security risk! (web, android, ios)
- ERR_AUTHORIZATION_FAILED ... The authorization failed.
- ERR_NO_ACCESS_TOKEN ... No access_token found. (web, android)
- ERR_NO_AUTHORIZATION_CODE ... No authorization code was returned in the redirect response. (web, android, ios)
- USER_CANCELLED ... The user cancelled the login flow. (web, android, ios)
- ERR_CUSTOM_HANDLER_LOGIN ... Login through custom handler class failed. See logs and check your code. (android, ios)
- ERR_CUSTOM_HANDLER_LOGOUT ... Logout through custom handler class failed. See logs and check your code. (android, ios)
- ERR_ANDROID_NO_BROWSER ... No suitable browser could be found! (Android)
- ERR_ANDROID_RESULT_NULL ... The auth result is null. The intent in the ActivityResult is null. This might be a valid
state but make sure you configured Android part correctly! See Platform Android
- ERR_GENERAL ... A unspecific error. Check the logs to see want exactly happened. (web, android, ios)

#### refreshToken()

- ERR_PARAM_NO_APP_ID ... The appId / clientId is missing. (android, ios)
- ERR_PARAM_NO_ACCESS_TOKEN_ENDPOINT ... The access token endpoint url is missing. It is only needed on refresh, on
authenticate it is optional. (android, ios)
- ERR_PARAM_NO_REFRESH_TOKEN ... The refresh token is missing. (android, ios)
- ERR_NO_ACCESS_TOKEN ... No access_token found. (web, android)
- ERR_GENERAL ... A unspecific error. Check the logs to see want exactly happened. (android, ios)

Platform: Web/PWA

This implementation just opens a browser window to let users enter their credentials.

As there is no provider SDK used to accomplish OAuth, no additional javascript files must be loaded and so there is no
performance
impact using this plugin in a web application.

Platform: Android

There are two options when configuring an OAuth 2 protocol:

1. Some OAuth providers allow using their service _without_ implementing their SDK. For these providers, you can use the
default config available,
2. Other OAuth providers (e.g. Facebook) force developers to use their SDK. For these providers, you can implement a
_Custom OAuth Handler_.

$3

> [!NOTE]
> You can skip this, if you're only exclusively configuring providers using a _Custom OAuth Handler_.

> [!NOTE]
> For more information about configuring your Android app, refer to
> the offical Capacitor documentation

#### android/app/src/main/res/AndroidManifest.xml

The AndroidManifest.xml in your Capacitor Android project already contains

`xml







`

Find the following line in your AndroidManifest.xml

`xml


`

and change it to

`xml


`

> [!NOTE]
> Actually any value for android:host will do. It does not have to be oauth.
>
> This will fix an issues within the oauth workflow where the application is shown twice.
>
> See Issue #15 for details what happens.

#### android/app/src/main/res/values/strings.xml

In your strings.xml change the custom_url_scheme string to your actual scheme value. Do NOT include
://oauth/redirect or other endpoint urls here!

`xml

com.example.yourapp



`

#### android/app/build.gradle

`groovy
android.defaultConfig.manifestPlaceholders = [
// change to the 'custom_url_scheme' value in your strings.xml. They need to be the same. e.g.
"appAuthRedirectScheme": "com.example.yourapp"
]
`

Troubleshooting

1. If your appAuthRedirectScheme does not get recognized because you are using a library that replaces it
(e.g.: onesignal-cordova-plugin), you will have to add it to your buildTypes like the following:

`groovy
android.buildTypes.debug.manifestPlaceholders = [
'appAuthRedirectScheme': '<@string/custom_url_scheme from string.xml>' // e.g. com.companyname.appname
]
android.buildTypes.release.manifestPlaceholders = [
'appAuthRedirectScheme': '<@string/custom_url_scheme from string.xml>' // e.g. com.companyname.appname
]
`

2. "ERR_ANDROID_RESULT_NULL":
See Issue #52 for details.
I cannot reproduce this behaviour. Moreover, there might be situation this state is valid. In other cases e.g. in the
linked issue a configuration tweak fixed it.

3. To prevent some logout issues on certain OAuth2 providers (like Salesforce for example), you should provide the
id_token parameter on the logout(...) function.
This ensures that not only the cookies are deleted, but also the logout link is called from the OAuth2 provider.
Also, it uses the system browser that the plugin uses (and not the user's default browser) to call the logout URL.
This additionally ensures that the cookies are deleted in the correct browser.

$3

Some OAuth providers (e.g. Facebook) force developers to use their SDK.

This plugin should be as generic as possible, so I don't want to include provider specific dependencies.

Therefore, I created a mechanism which let developers integrate custom SDK features in this plugin.
Simply configure a full qualified classname in the option property android.customHandlerClass.
This class has to implement com.getcapacitor.community.genericoauth2.handler.OAuth2CustomHandler.

Refer to the Facebook example below for a reference implementation.

Platform: iOS

There are two options when configuring an OAuth 2 protocol:

1. Some OAuth providers allow using their service _without_ implementing their SDK. For these providers, you can use the
default config available,
2. Other OAuth providers (e.g. Facebook) force developers to use their SDK. For these providers, you can implement a
_Custom OAuth Handler_.

$3

> [!NOTE]
> You can skip this, if you're only exclusively configuring providers using a _Custom OAuth Handler_.

Open ios/App/App/Info.plist in XCode (Context menu -> Open as -> Source) and add the value of redirectUrl from your
config without :/ like that

`xml

CFBundleURLTypes


CFBundleURLSchemes

com.companyname.appname



`

$3

Some OAuth providers (e.g. Facebook) force developers to use their SDK.

This plugin should be as generic as possible, so I don't want to include provider specific dependencies.

Therefore, I created a mechanism which let developers integrate custom SDK features in this plugin.
Simply configure the class name in the option property ios.customHandlerClass.
This class has to implement CapacitorCommunityGenericOauth2.OAuth2CustomHandler.

Refer to the Facebook example below for a reference implementation.

Platform: Electron

- No timeline.

Where to store access tokens?

You can use the capacitor-secure-storage plugin for
this.

This plugin stores data in secure locations for natives devices.

- For Android, it will store data in a AndroidKeyStore and
a SharedPreferences.
- For iOS, it will store data in a SwiftKeychainWrapper.

List of Providers

These are some of the providers that can be configured with this plugin. I'm happy to add others ot the list, if you let
me know.

| Name | Example (config,...) | Notes |
|----------|----------------------------------------------------|----------|
| Google | see below | |
| Facebook | see below | |
| Azure | see below | |
| Apple | see below | ios only |

Examples

$3

#### iOS 13+

Minimum config

`typescript
appleLogin()
{
GenericOAuth2.authenticate({
appId: "xxxxxxxxx",
authorizationBaseUrl: "https://appleid.apple.com/auth/authorize",
});
}
`

The plugin requires authorizationBaseUrl as it triggers the native support and because it is needed for other
platforms anyway. Those platforms are not supported yet.

appId is required as well for internal, generic reasons and any not blank value is fine.

It is also possible to control the scope although Apple only supports email and/or fullName. Add
siwaUseScope: true to the ios section.
Then you can use scope: "fullName", scope: "email" or both but the latter is the default one if siwaUseScope is
not set or false.

`typescript
appleLogin()
{
GenericOAuth2.authenticate({
appId: "xxxxxxxxx",
authorizationBaseUrl: "https://appleid.apple.com/auth/authorize",
ios: {
siwaUseScope: true,
scope: "fullName"
}
});
}
`

As "Signin with Apple" is only supported since iOS 13 you should show the according button only in that case.

In Angular do sth like

`typescript
import {Component, OnInit} from '@angular/core';
import {Device, DeviceInfo} from '@capacitor/device';
import {GenericOAuth2} from '@capacitor-community/generic-oauth2';

@Component({
templateUrl: './siwa.component.html',
})
export class SiwaComponent implements OnInit {
ios: boolean;
siwaSupported: boolean;
deviceInfo: DeviceInfo;

async ngOnInit() {
this.deviceInfo = await Device.getInfo();
this.ios = this.deviceInfo.platform === 'ios';
if (this.ios) {
const majorVersion: number = +this.deviceInfo.osVersion.split('.')[0];
this.siwaSupported = majorVersion >= 13;
}
}
}
`

And show the button only if siwaSupported is true.

The response contains these fields:

`
"id"
"given_name"
"family_name"
"email"
"real_user_status"
"state"
"id_token"
"code"
`

#### iOS <12

not supported

#### PWA

not supported

#### Android

not supported

$3

It's important to use the urls you see in the Azure portal for the specific platform.

Note: Don't be confused by the fact that the Azure portal shows "Azure Active Directory" and "Azure AD B2C" services.
They share the same core features and therefore the plugin should work either way.

#### PWA

`typescript
import {
OAuth2AuthenticateOptions,
GenericOAuth2,
} from '@capacitor-community/generic-oauth2';

export class AuthService {
getAzureB2cOAuth2Options(): OAuth2AuthenticateOptions {
return {
appId: environment.oauthAppId.azureBc2.appId,
authorizationBaseUrl: https://login.microsoftonline.com/${environment.oauthAppId.azureBc2.tenantId}/oauth2/v2.0/authorize,
scope: 'https://graph.microsoft.com/User.Read', // See Azure Portal -> API permission
accessTokenEndpoint: https://login.microsoftonline.com/${environment.oauthAppId.azureBc2.tenantId}/oauth2/v2.0/token,
resourceUrl: 'https://graph.microsoft.com/v1.0/me/',
responseType: 'code',
pkceEnabled: true,
logsEnabled: true,
web: {
redirectUrl: environment.redirectUrl,
windowOptions: 'height=600,left=0,top=0',
},
android: {
redirectUrl: 'msauth://{package-name}/{url-encoded-signature-hash}', // See Azure Portal -> Authentication -> Android Configuration "Redirect URI"
},
ios: {
pkceEnabled: true, // workaround for bug #111
redirectUrl: 'msauth.{package-name}://auth',
},
};
}
}
`

##### Custom Scopes

If you need to use custom scopes configured in "API permissions" and created in "Expose an API" in Azure Portal you
might need
to remove the resourceUrl parameter if your scopes are not included in the response. I can not give a clear advise on
those Azure specifics.
Try to experiment with the config until Azure includes everything you need in the response.

##### Prior configs

#### Android

If you have only Azure B2C as identity provider you have to add a new intent-filter to your main activity in
AndroidManifest.xml.

`xml





android:path="@string/azure_b2c_signature_hash"/>

`

If you have multiple identity providers or your logins always ends in a USER_CANCELLED error like
in #178
you have to create an additional Activity in AndroidManifest.xml.

These are both activities! Make sure to replace com.company.project.MainActivity with your real qualified class path!

`xml

android:configChanges="orientation|keyboardHidden|keyboard|screenSize|locale|smallestScreenSize|screenLayout|uiMode"
android:name="com.company.project.MainActivity"
android:label="@string/title_activity_main"
android:launchMode="singleTask"
android:theme="@style/AppTheme.NoActionBarLaunch">





android:path="@string/azure_b2c_signature_hash"/>


`

Values for android/app/src/main/res/values/string.xml. Replace the example values!

`
Your Project's Name/string>
com.company.project
foo
com.company.project
msauth
/your-signature-hash
`

See Android Default Config

#### iOS

Open Info.plist in XCode by clicking right on that file -> Open as -> Source Code. Note: XCode does not "like" files
opened and changed externally.

`xml

CFBundleURLTypes


CFBundleURLSchemes


msauth.com.yourcompany.yourproject



`

Important:

- Do not enter :// as part of your redirect url
- Make sure the msauth. prefix is present

#### Troubleshooting

In case of problems please read #91
and #96

See this example repo by @loonix.

$3

#### PWA

`typescript
import {GenericOAuth2} from "@capacitor-community/generic-oauth2";

googleLogin()
{
GenericOAuth2.authenticate({
authorizationBaseUrl: "https://accounts.google.com/o/oauth2/auth",
accessTokenEndpoint: "https://www.googleapis.com/oauth2/v4/token",
scope: "email profile",
resourceUrl: "https://www.googleapis.com/userinfo/v2/me",
web: {
appId: environment.oauthAppId.google.web,
responseType: "token", // implicit flow
accessTokenEndpoint: "", // clear the tokenEndpoint as we know that implicit flow gets the accessToken from the authorizationRequest
redirectUrl: "http://localhost:4200",
windowOptions: "height=600,left=0,top=0"
},
android: {
appId: environment.oauthAppId.google.android,
responseType: "code", // if you configured a android app in google dev console the value must be "code"
redirectUrl: "com.companyname.appname:/" // package name from google dev console
},
ios: {
appId: environment.oauthAppId.google.ios,
responseType: "code", // if you configured a ios app in google dev console the value must be "code"
redirectUrl: "com.companyname.appname:/" // Bundle ID from google dev console
}
}).then(resourceUrlResponse => {
// do sth e.g. check with your backend
}).catch(reason => {
console.error("Google OAuth rejected", reason);
});
}
`

#### Android

See Android Default Config

#### iOS

See iOS Default Config

$3

#### PWA

`typescript
import {GenericOAuth2} from "@capacitor-community/generic-oauth2";

facebookLogin()
{
let fbApiVersion = "2.11";
GenericOAuth2.authenticate({
appId: "YOUR_FACEBOOK_APP_ID",
authorizationBaseUrl: "https://www.facebook.com/v" + fbApiVersion + "/dialog/oauth",
resourceUrl: "https://graph.facebook.com/v" + fbApiVersion + "/me",
web: {
responseType: "token",
redirectUrl: "http://localhost:4200",
windowOptions: "height=600,left=0,top=0"
},
android: {
customHandlerClass: "com.companyname.appname.YourAndroidFacebookOAuth2Handler",
},
ios: {
customHandlerClass: "App.YourIOsFacebookOAuth2Handler",
}
}).then(resourceUrlResponse => {
// do sth e.g. check with your backend
}).catch(reason => {
console.error("FB OAuth rejected", reason);
});
}
`

Android and iOS

Since October 2018 Strict Mode for Redirect Urls is always on.

> Use Strict Mode for Redirect URIs

> Only allow redirects that use the Facebook SDK or that exactly match the Valid OAuth Redirect URIs. Strongly
> recommended.

Before that it was able to use fb:/authorize in a Android or iOS app and get the accessToken.

Unfortunately now we have to use the SDK for Facebook Login.

I don't want to have a dependency to facebook for users, who don't need Facebook OAuth.

To address this problem I created a integration with custom code in your app customHandlerClass

#### Android

See https://developers.facebook.com/docs/facebook-login/android/ for more background on how to configure Facebook in
your Android app.

1. Add implementation 'com.facebook.android:facebook-login:4.36.0' to android/app/build.gradle as dependency.

2. Add to string.xml

`xml




fb


`

3. Add to AndroidManifest.xml

`xml

android:configChanges=
"keyboard|keyboardHidden|screenLayout|screenSize|orientation"
android:label="@string/app_name"/>









`

4. Create a custom handler class

`java
package com.companyname.appname;

import android.app.Activity;
import com.companyname.appname.MainActivity;
import com.facebook.AccessToken;
import com.facebook.FacebookCallback;
import com.facebook.FacebookException;
import com.facebook.login.DefaultAudience;
import com.facebook.login.LoginBehavior;
import com.facebook.login.LoginManager;
import com.facebook.login.LoginResult;
import com.getcapacitor.PluginCall;
import com.getcapacitor.community.genericoauth2.handler.AccessTokenCallback;
import com.getcapacitor.community.genericoauth2.handler.OAuth2CustomHandler;

import java.util.Collections;

public class YourAndroidFacebookOAuth2Handler implements OAuth2CustomHandler {

@Override
public void getAccessToken(
Activity activity,
PluginCall pluginCall,
final AccessTokenCallback callback
) {
AccessToken accessToken = AccessToken.getCurrentAccessToken();
if (AccessToken.isCurrentAccessTokenActive()) {
callback.onSuccess(accessToken.getToken());
} else {
LoginManager l = LoginManager.getInstance();
l.logInWithReadPermissions(
activity,
Collections.singletonList("public_profile")
);
l.setLoginBehavior(LoginBehavior.WEB_ONLY);
l.setDefaultAudience(DefaultAudience.NONE);
LoginManager
.getInstance()
.registerCallback(
((MainActivity) activity).getCallbackManager(),
new FacebookCallback() {
@Override
public void onSuccess(LoginResult loginResult) {
callback.onSuccess(loginResult.getAccessToken().getToken());
}

@Override
public void onCancel() {
callback.onCancel();
}

@Override
public void onError(FacebookException error) {
callback.onCancel();
}
}
);
}
}

@Override
public boolean logout(Activity activity, PluginCall pluginCall) {
LoginManager.getInstance().logOut();
return true;
}
}

`

5. Change your MainActivity like

`java
public class MainActivity extends BridgeActivity {

private CallbackManager callbackManager;

@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Initialize Facebook SDK
FacebookSdk.sdkInitialize(this.getApplicationContext());
callbackManager = CallbackManager.Factory.create();
}

@Override
protected void onActivityResult(
int requestCode,
int resultCode,
Intent data
) {
super.onActivityResult(requestCode, resultCode, data);
if (callbackManager.onActivityResult(requestCode, resultCode, data)) {
return;
}
}

public CallbackManager getCallbackManager() {
return callbackManager;
}
}

`

iOS

See https://developers.facebook.com/docs/swift/getting-started and https://developers.facebook.com/docs/swift/login

1. Add Facebook pods to ios/App/Podfile and run pod install afterwards

`
platform :ios, '13.0'
use_frameworks!

workaround to avoid Xcode caching of Pods that requires

target 'App' do
capacitor_pods
# Add your Pods here
pod 'FacebookCore'
pod 'FacebookLogin'
end
`

2. Add some Facebook configs to your Info.plist

`xml

CFBundleURLTypes


CFBundleURLSchemes

fb{your-app-id}



FacebookAppID
{your-app-id}
FacebookDisplayName
{your-app-name}
LSApplicationQueriesSchemes

fbapi
fb-messenger-share-api
fbauth2
fbshareextension

`

3. Create a custom handler class

`swift
import Foundation
import FacebookCore
import FacebookLogin
import Capacitor
import CapacitorCommunityGenericOauth2

@objc class YourIOsFacebookOAuth2Handler: NSObject, OAuth2CustomHandler {

required override init() {
}

func getAccessToken(viewController: UIViewController, call: CAPPluginCall, success: @escaping (String) -> Void, cancelled: @escaping () -> Void, failure: @escaping (Error) -> Void) {
if let accessToken = AccessToken.current {
success(accessToken.tokenString)
} else {
DispatchQueue.main.async {
let loginManager = LoginManager()
// I only need the most basic permissions but others are available
loginManager.logIn(permissions: [ .publicProfile ], viewController: viewController) { result in
switch result {
case .success(_, _, let accessToken):
success(accessToken.tokenString)
case .failed(let error):
failure(error)
case .cancelled:
cancelled()
}
}
}
}
}

func logout(viewController: UIViewController, call: CAPPluginCall) -> Bool {
let loginManager = LoginManager()
loginManager.logOut()
return true
}
}
`

This handler will be automatically discovered up by the plugin and handles the login using the Facebook SDK.
See https://developers.facebook.com/docs/swift/login/#custom-login-button for details.

4. The users that have redirect problem after success grant add the following code to ios/App/App/AppDelegate.swift.
This code correctly delegate the FB redirect url to be managed by Facebook SDK.

`swift
import UIKit
import FacebookCore
import FacebookLogin
import Capacitor

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

var window: UIWindow?

// other methods

func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
// Called when the app was launched with a url. Feel free to add additional processing here,
// but if you want the App API to support tracking app url opens, make sure to keep this call

if let scheme = url.scheme, let host = url.host {
let appId: String = Settings.appID!
if scheme == "fb\(appId)" && host == "authorize" {
return ApplicationDelegate.shared.application(app, open: url, options: options)
}
}

return CAPBridge.handleOpenUrl(url, options)
}

// other methods
}
``

Contribute

See Contribution Guidelines.

License

MIT. See LICENSE.

Disclaimer

We have no business relation to Ionic.