diff options
Diffstat (limited to 'vnfmarket/src/main/webapp/vnfmarket/node_modules/basic-auth/README.md')
-rw-r--r-- | vnfmarket/src/main/webapp/vnfmarket/node_modules/basic-auth/README.md | 78 |
1 files changed, 0 insertions, 78 deletions
diff --git a/vnfmarket/src/main/webapp/vnfmarket/node_modules/basic-auth/README.md b/vnfmarket/src/main/webapp/vnfmarket/node_modules/basic-auth/README.md deleted file mode 100644 index b3d82473..00000000 --- a/vnfmarket/src/main/webapp/vnfmarket/node_modules/basic-auth/README.md +++ /dev/null @@ -1,78 +0,0 @@ -# basic-auth - -[![NPM Version][npm-image]][npm-url] -[![NPM Downloads][downloads-image]][downloads-url] -[![Node.js Version][node-version-image]][node-version-url] -[![Build Status][travis-image]][travis-url] -[![Test Coverage][coveralls-image]][coveralls-url] - -Generic basic auth Authorization header field parser for whatever. - -## Installation - -``` -$ npm install basic-auth -``` - -## API - -```js -var auth = require('basic-auth') -``` - -### auth(req) - -Get the basic auth credentials from the given request. The `Authorization` -header is parsed and if the header is invalid, `undefined` is returned, -otherwise an object with `name` and `pass` properties. - -## Example - -Pass a node request or koa Context object to the module exported. If -parsing fails `undefined` is returned, otherwise an object with -`.name` and `.pass`. - -```js -var auth = require('basic-auth'); -var user = auth(req); -// => { name: 'something', pass: 'whatever' } - -``` - -### With vanilla node.js http server - -```js -var http = require('http') -var auth = require('basic-auth') - -// Create server -var server = http.createServer(function (req, res) { - var credentials = auth(req) - - if (!credentials || credentials.name !== 'john' || credentials.pass !== 'secret') { - res.statusCode = 401 - res.setHeader('WWW-Authenticate', 'Basic realm="example"') - res.end('Access denied') - } else { - res.end('Access granted') - } -}) - -// Listen -server.listen(3000) -``` - -# License - -[MIT](LICENSE) - -[npm-image]: https://img.shields.io/npm/v/basic-auth.svg -[npm-url]: https://npmjs.org/package/basic-auth -[node-version-image]: https://img.shields.io/node/v/basic-auth.svg -[node-version-url]: https://nodejs.org/en/download -[travis-image]: https://img.shields.io/travis/jshttp/basic-auth/master.svg -[travis-url]: https://travis-ci.org/jshttp/basic-auth -[coveralls-image]: https://img.shields.io/coveralls/jshttp/basic-auth/master.svg -[coveralls-url]: https://coveralls.io/r/jshttp/basic-auth?branch=master -[downloads-image]: https://img.shields.io/npm/dm/basic-auth.svg -[downloads-url]: https://npmjs.org/package/basic-auth |