Passport-HeaderAPIKey
Passport strategy for authenticating with a apikey.
This module lets you authenticate using a apikey in your Node.js applications which is used to build rest apis. By plugging into Passport, apikey authentication can be easily and unobtrusively integrated into any application or framework that supports Connect-style middleware, including Express.
Installation
$ npm install @neuralegion/passport-headerapikey
Usage
Configure Strategy
The api key authentication strategy authenticates users using a apikey.
The strategy requires a verify callback, which accepts these
credentials and calls done providing a user.
const HeaderAPIKeyStrategy = require('passport-headerapikey').HeaderAPIKeyStrategy
passport.use(new HeaderAPIKeyStrategy(
{ header: 'Authorization', prefix: 'Api-Key' },
(apikey, done) => {
User.findOne({ apikey: apikey }, (err, user) => {
if (err) { return done(err); }
if (!user) { return done(null, false); }
return done(null, user);
});
}
));
Authenticate Requests
Use passport.authenticate(), specifying the 'headerapikey' strategy, to
authenticate requests.
For example, as route middleware in an Express application:
app.post('/api/authenticate',
passport.authenticate('headerapikey', { session: false, failureRedirect: '/api/unauthorized' }),
function(req, res) {
res.json({ message: "Authenticated" })
});
Examples
curl -v --header "Authorization: Api-Key asdasjsdgfjkjhg" http://127.0.0.1:3000/api/authenticate