Password authentication strategy using Atlassian Crowd for Passport
Passport strategy for authenticating Atlassian Crowd
given a username and password.
This module lets you authenticate using a username and password in your Node.js
applications. By plugging into Passport, atlassian crowd authentication can be easily and
unobtrusively integrated into any application or framework that supports
Connect-style middleware, including
Express.
This is a fork of the excellent, but discontinued, passport-atlassian-crowd
$ npm install passport-atlassian-crowd2
#### Configure Strategy
The atlassian-crowd authentication strategy authenticates users using a username and
password via a REST call to your Crowd server. The strategy requires a verify callback, which accepts these
credentials and calls done providing a user. This strategy can also be used with JIRA running as a crowd server.
A valid application will have to be configured in Atlassian Crowd to be allowed to make requests.
Pass an optional retrieveGroupMemberships:true flag to populate a groups array on the userprofile
with all the groups the user is a member of in Crowd.
passport.use(new AtlassianCrowdStrategy({
crowdServer:"http://localhost:2990/jira",
crowdApplication:"nodejs",
crowdApplicationPassword:"password",
retrieveGroupMemberships:false
},
function (userprofile, done) {
Users.findOrCreate(userprofile, function(err,user) {
if(err) return done(err);
return done(null, user);
});
}
));
#### Authenticate Requests
Use passport.authenticate(), specifying the 'atlassian-crowd' strategy, to
authenticate requests.
For example, as route middleware in an Express
application:
app.post('/login',
passport.authenticate('atlassian-crowd', { failureRedirect: '/login' }),
function(req, res) {
res.redirect('/');
});
For a complete, working example, refer to the login example.
* 0.0.17 - Fixed encoding issues with non-ascii usernames
* 0.0.16 - Added Request Timeout (options.crowdRequestTimeout, default 5000ms)
* 0.0.14 - Added Proxy Support (options.proxyURL)
* 0.0.13 - Fixed encoding issues
* 0.0.10 - Fixed a bug with special characters in username/password (UTF-8 multibyte encoding)
* 0.0.9 - First release from celix. Only cosmetic changes.
* 0.0.8 - Number of fixes contribued by Billy Keyes: Update dependecy to passport-strategy, fixed duplicate callbacks, excessive logging and support for additional request params
* 0.0.3 - Added support for newer version of Crowd REST API (contributed by Frank Febbraro)
* 0.0.4 - Fixed a bug with pathname when there's no context path specified in the crowd url
* 0.0.5 - Better error handling
(The MIT License)
Copyright (c) 2012 Andreas Knecht
Copyright (c) 2016 celix Solutions GmbH
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.