/check-auth-header

check key in auth header (middleware for express.js)

Primary LanguageJavaScriptMIT LicenseMIT

check-auth-header

check key in auth header (middleware for express.js)

Usage

Valid auth with header X-API-Key: secretKey

const checkAuthKey = require('check-auth-header');

const app = express();

app.use(checkAuthKey({
    authKeys: ['secretKey'],
    authHeader: 'X-API-Key',
}));

Valid auth via function

const authFn = (key) => {
    return key === 'secret',
};

app.use(checkAuthKey({
    authFn,
    authHeader: 'X-API-Key',
}));

Exclude path / for API scheme or readme

const authFn = (key) => {
    return key === 'secret',
};

app.use(checkAuthKey({
    authFn,
    authHeader: 'X-API-Key',
    excludes: ['/v1/api']
}));