passport-headerapikey

What is passport-headerapikey?

The passport-headerapikey npm package is a Passport strategy for authenticating with an API key passed in a header. It allows you to protect your routes by requiring a valid API key for access.

What are passport-headerapikey's main functionalities?

Basic API Key Authentication

This feature allows you to set up basic API key authentication using the passport-headerapikey strategy. The provided code demonstrates how to configure the strategy and protect a route in an Express application.

const passport = require('passport');
const HeaderAPIKeyStrategy = require('passport-headerapikey').HeaderAPIKeyStrategy;

passport.use(new HeaderAPIKeyStrategy(
  { header: 'Authorization', prefix: 'Api-Key ' },
  false,
  (apikey, done) => {
    if (apikey === 'your_api_key') {
      return done(null, true);
    } else {
      return done(null, false);
    }
  }
));

// Express setup
const express = require('express');
const app = express();

app.use(passport.initialize());

app.get('/protected', passport.authenticate('headerapikey', { session: false }), (req, res) => {
  res.send('This is a protected route');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Other packages similar to passport-headerapikey

passport-http-bearer

The passport-http-bearer package is a Passport strategy for authenticating with a bearer token. It is similar to passport-headerapikey in that it allows you to protect routes using a token, but it uses the Bearer token scheme instead of a custom header.

passport-custom

The passport-custom package allows you to create custom authentication strategies. It provides more flexibility compared to passport-headerapikey, as you can define your own logic for extracting and validating credentials from the request.

README

The README file is missing