README.md

@oauth-everything/passport-battlenet

A Passport strategy for authenticating with Battle.net using OAuth 2.0 and the Battle.net API.

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

Install

$ npm install @oauth-everything/passport-battlenet

Configure Strategy

The Battle.net authentication strategy authenticates users using a Battle.net account and OAuth 2.0 tokens. The app 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 access token and optional refresh token, as well as profile which contains the authenticated user's Battle.net profile. The verify callback must call cb providing a user to complete authentication.

passport.use(new Strategy(
    {
        clientID: BATTLENET_APP_ID,
        clientSecret: BATTLENET_APP_SECRET,
        callbackURL: "http://localhost:3000/auth/battlenet/callback"
    },
    (accessToken: string, refreshToken: string, profile: Profile, cb: VerifyCallback<User>) => {

        User.findOrCreate({ battlenetId: profile.id }, (err: Error, user: User) => {
            return cb(err, user);
        });

    }
));

Authenticate Requests

Use passport.authenticate(), specifying the 'battlenet' strategy, to authenticate requests.

For example, as route middleware in an Express application:

app.get('/auth/battlenet',
  passport.authenticate('battlenet'));

app.get('/auth/battlenet/callback',
  passport.authenticate('battlenet', { failureRedirect: '/login' }),
  function(req, res) {
    // Successful authentication, redirect home.
    res.redirect('/');
  });

License

The MPL v2 License