https://github.com/rumkin/http-auth-payload

HTTP authorization header middleware
https://github.com/rumkin/http-auth-payload

auth authorization connect express http http-header javascript

Last synced: 10 months ago
JSON representation

HTTP authorization header middleware

• Host: GitHub
• URL: https://github.com/rumkin/http-auth-payload
• Owner: rumkin
• License: other
• Created: 2016-09-10T19:34:06.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-10-07T17:05:21.000Z (over 9 years ago)
• Last Synced: 2025-03-07T16:41:08.519Z (11 months ago)
• Topics: auth, authorization, connect, express, http, http-header, javascript
• Language: JavaScript
• Size: 9.77 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HTTP Authorization Payload Middleware

Parse authorization http header and add auth information into request object.

![Build](https://img.shields.io/travis/rumkin/http-auth-payload.svg)

## Install

Install with npm:

```bash

npm i http-auth-payload

```

## Usage

Usage example with express application:

```javascript

const express = require('express');

const httpAuthPayload = require('http-auth-payload');

express()

    .use(httpAuthPayload)

    .use((req, res, next) => {

        if (req.auth.type !== 'bearer') {

            res.status(403).send('Access denied');

            return;

        }

        if (req.auth.payload !== 'secret-token') {

            res.status(403).send('Access denied');

            return;

        }

        next();

    })

    .use((req, res, next) => {

        res.send('Logged in');

    })

    .listen();

```

If authorization header not passed or empty then type has value `none` and

request property 'hasAuth' is `false`.

## API

### (req, res, next)

Module exports middleware.

### parse(authorization) => AuthObject

Method parse authorization and return auth object:

```

{

    type: 'http',

    payload: '...',

}

```

### parseRequest(request) => AuthObject

Method get request's authorization header and parse it with `parse` method.

## License

MIT.