Passport strategy for authenticating with Visual Studio Online accounts using the OAuth 2.0 API.
This module lets you authenticate using Visual Studio Online in your Node.js applications. Visual Studio Online authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
$ npm install passport-vso
The Visual Studio Online authentication strategy authenticates users using a VSO account and OAuth 2.0 JWT bearer tokens.
The strategy is constructed with 2 parameters
new VsoOAuth2Strategy(options, verify)Applications must supply a verify callback, for which the function signature is:
function([req], accessToken, refreshToken, [params], profile, done) { ... }The use of the req argument is controlled by the option
The verify callback is responsible for finding or creating the user, and invoking done with the following arguments:
done(err, user, info);user should be set to false to indicate an authentication failure.
Additional info can optionally be passed as a third argument, typically
used to display informational messages. If an exception occured, err
should be set.
Options:
authorizationURLURL used to obtain an authorization grant (default: VSO auth url)tokenURLURL used to obtain an access token (default: VSO token url)profileURLURL used to obtain a user profile (default: VSO user profile url)sessionKeykey used to store auth info on session (default: 'vso:' + authorizationURL hostname)clientIDidentifies client to service providerclientSecretsecret used to establish ownership of the client identifercallbackURLURL to which the service provider will redirect the user after obtaining authorizationpassReqToCallbackwhentrue,reqis the first argument to the verify callback (default:false)
passport.use(
new VsoOAuth2Strategy({
clientID: VSO_CLIENT_ID,
clientSecret: VSO_CLIENT_SECRET,
callbackURL: "http://www.example.com/auth/vso/callback",
passReqToCallback: true
},
function(req, accessToken, refreshToken, params, profile, done) {
// token expiration info available from params.expires_in
User.findOrCreate({ vsoId: profile.id }, function (err, user) {
return done(err, user);
});
}
)
);Use passport.authenticate(), specifying the 'vso' strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.get('/auth/vso',
passport.authenticate('vso', { scope: ['wl.signin', 'wl.basic'] }));
app.get('/auth/vso/callback',
passport.authenticate('vso', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
For a complete, working example, refer to the login example.
$ npm install
$ npm test
- Patrick Hallisey
- Mickey Mullin
Forked from passport-windowslive by Jared Hanson
Copyright (c) 2015 Patrick Hallisey