https://github.com/ayogohealth/cordova-plugin-oauth

Cordova plugin for performing OAuth login flows.
https://github.com/ayogohealth/cordova-plugin-oauth

cordova cordova-plugin hacktoberfest oauth oauth2

Last synced: 6 days ago
JSON representation

Cordova plugin for performing OAuth login flows.

• Host: GitHub
• URL: https://github.com/ayogohealth/cordova-plugin-oauth
• Owner: AyogoHealth
• License: apache-2.0
• Created: 2019-03-22T04:50:22.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-20T06:37:46.000Z (5 months ago)
• Last Synced: 2024-12-23T11:19:59.043Z (20 days ago)
• Topics: cordova, cordova-plugin, hacktoberfest, oauth, oauth2
• Language: Swift
• Size: 96.7 KB
• Stars: 24
• Watchers: 8
• Forks: 27
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


cordova-plugin-oauth

====================

This plugin provides a mechanism for showing an OAuth flow in a secured

system-provided browser view and receiving the result via a Message event.

On iOS, this uses ASWebAuthenticationSession (iOS >=12),

SFAuthenticationSession (iOS 11), SFSafariViewController (iOS >=8, <=10),

falling back to Safari.

On Android, this uses Custom Tabs in the user's preferred web application,

falling back to their browser.

**Note:** This plugin might conflict with the Cordova In-App Browser plugin!

> ℹ️ **This plugin uses AndroidX!**

>

> Use version 3.x if you are building without AndroidX enabled.

Installation

------------

```

cordova plugin add cordova-plugin-oauth [--variable URL_SCHEME=mycoolapp]

```

By default, the plugin registers the app ID as a scheme to be used as the

OAuth callback URL, and expects a host of `oauth_callback` (i.e., if your

app's ID is `com.example.foo`, your OAuth redirect URL should be

`com.example.foo://oauth_callback`).

The scheme for the OAuth callback URL can be changed by providing a

`URL_SCHEME` variable when installing. If your `URL_SCHEME` is `mycoolapp`,

then your OAuth redirect URL should be `mycoolapp://oauth_callback`.

Supported Platforms

-------------------

* **iOS** (cordova-ios >= 6.1.0)

* **Android** (cordova-android >= 9.0.0)

Usage

-----

1.  Trigger the plugin by opening the OAuth login page in a new window, with a

    window name that includes `"oauth:"`:

    ```javascript

    var endpoint = 'https://accounts.google.com/o/oauth2/v2/auth?....';

    window.open(endpoint, 'oauth:google', '');

    ```

2.  The plugin will open the OAuth login page in a new browser window.

3.  When the OAuth process is complete and it redirects to your app scheme, the

    plugin will send a message to the Cordova app.

    The message begins with `oauth::` and is followed by a JSON object

    containing all of the key/value pairs from the OAuth redirect query string.

    ```javascript

    // Called from a callback URL like

    // com.example.foo://oauth_callback?code=b10a8db164e0754105b7a99be72e3fe5

    // it would be received in JavaScript like this:

    window.addEventListener('message', function(event) {

      if (event.data.match(/^oauth::/)) {

        var data = JSON.parse(event.data.substring(7));

        // Use data.code

      }

    }

    ```

    The advantage of this implementation is that it can be made to work with

    Universal Links and App Links so that the same flow can be used in both

    mobile apps and web.

Contributing

------------

Contributions of bug reports, feature requests, and pull requests are greatly

appreciated!

Please note that this project is released with a [Contributor Code of

Conduct][coc]. By participating in this project you agree to abide by its

terms.

Licence

-------

Released under the Apache 2.0 Licence.  

Copyright © 2020-2022 Ayogo Health Inc.

[coc]: https://github.com/AyogoHealth/cordova-plugin-oauth/blob/main/CODE_OF_CONDUCT.md