Passport Authentication Strategy for MyUSA (my.usa.gov) using the OAuth 2.0 API.
This module lets you authenticate using MyUSA in your Node.js applications. By plugging into Passport, MyUSA authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express and Sails.
$ npm install passport-myusa
$ git clone git://github.com:Innovation-Toolkit/passport-myusa.git
$ cd passport-myusa
$ sudo npm link
change to your project's directory
$ npm link passport-myusa
The MyUSA authentication strategy authenticates users using an MyUSA
account and OAuth 2.0 tokens. The strategy requires a verify callback, which
accepts these credentials and calls done providing a user, as well as
options specifying a client ID, client secret, and callback URL.
Note that the callbackURL must match exactly the callback registered
for your application at MyUSA.
passport.use(new MyUSAStrategy({
clientID: MYUSA_CLIENT_ID,
clientSecret: MYUSA_CLIENT_SECRET,
callbackURL: "http://localhost:3000/auth/myusa/callback"
},
function(accessToken, refreshToken, profile, done) {
User.findOrCreate({ myusaId: profile.id }, function (err, user) {
return done(err, user);
});
}
));
The fields available in the profile are defined by Passport's Standard Profile. Two extra fields are included in the profile: _raw and _json. _raw is the raw response from the MyUSA server, whereas _json is the JSON-parsed representation of the raw response.
Use passport.authenticate(), specifying the 'myusa' strategy, to
authenticate requests. Set the requested scope, such as profile,
in the optional parameters during the authenticate phase.
For example, as route middleware in an Express application:
app.get('/auth/myusa',
passport.authenticate('myusa', { scope: ['profile.email'] }));
app.get('/auth/myusa/callback',
passport.authenticate('myusa', { failureRedirect: '/login' }),
function(req, res) {
// Successful authentication, redirect home.
res.redirect('/');
});
For a complete, working example, refer to the login example.
$ npm install --dev
$ make test
Register your application with MyUSA and save your Client ID and Secret. Select the scopes that your application requires. Valid scopes are:
- profile.email
- profile.title
- profile.first_name
- profile.middle_name
- profile.last_name
- profile.suffix
- profile.address
- profile.address2
- profile.city
- profile.state
- profile.zip
- profile.phone_number
- profile.mobile_number
- profile.gender
- profile.marital_status
- profile.is_parent
- profile.is_student
- profile.is_veteran
- profile.is_retired
- tasks
- notifications
- submit_forms
The user authentication URL and token exchange URL for MyUSA are https://my.usa.gov/oauth/authenticate
The REST API for profile information is https://my.usa.gov/api/profile
All API calls, including GET requests, must include the Authorization: Bearer <token> HTTP header. MyUSA does not support GET requests with the authorization token specified using a query string.
An example using node-oauth:
var OAuth2 = require('oauth').OAuth2;
var oauth = new OAuth2(CLIENT_ID, CLIENT_SECRET, '',
AUTHORIZATION_URL, TOKEN_URL, null);
// Use authorization headers for GET, not query string
oauth.useAuthorizationHeaderforGET(true);
// Make request
oauth2.get(PROFILE_URL, ACCESS_TOKEN, function (err, body, res) {
// parse profile
});
You may use this project under The MIT License.