passport-google-one-tap
TypeScript icon, indicating that this package has built-in type declarations

1.0.0 • Public • Published

passport-google-one-tap

Passport strategy for authenticating with Google One Tap.

This module lets you authenticate using Google One Tap in your Node.js applications. By plugging into Passport, Google One Tap authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.

npm MIT license Build status codecov

Install

npm install passport-google-one-tap

Usage

Create an Application

Before using passport-google-one-tap, you must register an application with Google. If you have not already done so, a new project can be created in the Google Developers Console. Your application will be issued a client ID and client secret, which need to be provided to the strategy.

Configure client side

The client side configuration is not covered by this plugin, you can follow the official Google One Tap Guidelines.

The client ID used in the front-end must be the same used in the strategy configuration and the login uri must be the same that you will configure in the Authenticate Requests section.

Minimal example:

<script src="https://accounts.google.com/gsi/client" async defer></script>
<div
  id="g_id_onload"
  data-client_id="YOUR_GOOGLE_CLIENT_ID"
  data-login_uri="https://your.domain/auth/one-tap/callback"
></div>

Configure Strategy

The Google One Tap authentication strategy verifies the Google ID token on your server side and retrieves the user information. The client ID and secret obtained when creating an application are supplied as options when creating the strategy. The strategy also requires a verify callback, which receives the profile with the authenticated user's Google profile. The verify callback must call done providing a user to complete authentication.

var GoogleOneTapStrategy =
  require("passport-google-one-tap").GoogleOneTapStrategy;

passport.use(
  new GoogleOneTapStrategy(
    {
      clientID: GOOGLE_CLIENT_ID, // your google client ID
      clientSecret: GOOGLE_CLIENT_SECRET, // your google client secret
      verifyCsrfToken: false, // whether to validate the csrf token or not
    },
    function (profile, done) {
      // Here your app code, for example:
      User.findOrCreate({ googleId: profile.id }, function (err, user) {
        return done(err, user);
      });
    }
  )
);

Authenticate Requests

Use passport.authenticate(), specifying the 'google-one-tap' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.post(
  "/auth/one-tap/callback",
  passport.authenticate(
    "google-one-tap",
    { failureRedirect: "/login" },
    (err, user) => {
      // Do whatever you need
    }
  ),
  function (req, res) {
    // Successful authentication, redirect home.
    res.redirect("/");
  }
);

Examples

Developers using the popular Express web framework can refer to an example as a starting point for their own web applications.

License

passport-google-one-tap is released under the MIT license:

MIT License

Copyright (c) 2021 Genially Web S.L.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Install

npm i passport-google-one-tap

DownloadsWeekly Downloads

13,317

Version

1.0.0

License

MIT

Unpacked Size

19.1 kB

Total Files

7

Last publish

Collaborators

  • geniallyteam