test

2023-12-05 17:03:01 +00:00
parent aec42feb5e
commit ea9944383f
1246 changed files with 125706 additions and 0 deletions
--- a/node_modules/http-auth/README.md
+++ b/node_modules/http-auth/README.md
@@ -0,0 +1,323 @@
+# http-auth
+[Node.js](http://nodejs.org/) package for HTTP basic and digest access authentication.
+
+[![Build Status](https://api.travis-ci.org/http-auth/http-auth.png)](https://travis-ci.org/http-auth/http-auth)
+
+## Installation
+
+Via git (or downloaded tarball):
+
+```bash
+$ git clone git://github.com/http-auth/http-auth.git
+```
+Via [npm](http://npmjs.org/):
+
+```bash
+$ npm install http-auth
+```	
+
+## Basic example
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+	realm: "Simon Area.",
+	file: __dirname + "/../data/users.htpasswd"
+});
+
+// Creating new HTTP server.
+http.createServer(basic, (req, res) => {
+	res.end(`Welcome to private area - ${req.user}!`);
+}).listen(1337);
+
+```
+## Custom authentication
+```javascript	
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+		realm: "Simon Area."
+	}, (username, password, callback) => { 
+	    // Custom authentication
+	    // Use callback(error) if you want to throw async error.
+		callback(username === "Tina" && password === "Bullock");
+	}
+);
+
+// Creating new HTTP server.
+http.createServer(basic, (req, res) => {
+	res.end(`Welcome to private area - ${req.user}!`);
+}).listen(1337);
+```
+
+## [express framework](http://expressjs.com/) integration
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+	realm: "Simon Area.",
+	file: __dirname + "/../data/users.htpasswd"
+});
+
+// Application setup.
+var app = express();
+app.use(auth.connect(basic));
+
+// Setup route.
+app.get('/', (req, res) => {
+    res.send(`Hello from express - ${req.user}!`);
+});
+```
+
+## [koa framework](http://koajs.com/) integration
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+    realm: "Simon Area.",
+    file: __dirname + "/../data/users.htpasswd"
+});
+
+// Final handler.
+app.use(function *(next) {
+    yield next;
+    this.body = `Hello from koa - ${this.req.user}!`;
+});
+
+// Enable auth.
+app.use(auth.koa(basic));
+```
+
+## For [koa@next](https://github.com/koajs/koa/tree/v2.x) you can use [http-auth-koa](https://github.com/http-auth/http-auth-koa)
+```javascript
+// Authentication module.
+import auth from 'http-auth'
+import koaAuth from 'http-auth-koa'
+const basic = auth.basic({
+    realm: "Simon Area.",
+    file: __dirname + "/../data/users.htpasswd"
+});
+
+// Koa setup.
+import Koa from 'koa'
+const app = new Koa();
+
+// Setup basic handler.
+app.use(async (ctx, next) => {
+    await next();
+    ctx.body = `Welcome to koa ${ctx.req.user}!`;
+});
+
+// Setup auth.
+app.use(koaAuth(basic));
+```
+
+## [hapi framework](http://hapijs.com/) integration
+```javascript
+// Authentication module.
+const auth = require('http-auth');
+
+// Setup auth.
+const basic = auth.basic({
+    realm: "Simon Area.",
+    file: __dirname + "/../data/users.htpasswd"
+});
+
+// Create server.
+const server = new Hapi.Server();
+server.connection({ port: 1337 });
+
+// Register auth plugin.
+server.register(auth.hapi());
+
+// Setup strategy.
+server.auth.strategy('http-auth', 'http', basic);
+
+// Setup route.
+server.route({
+    method: 'GET',
+    path: '/',
+    config: {
+        auth: 'http-auth',
+        handler: (request, reply) => {
+            reply(`Welcome from Hapi - ${request.auth.credentials.name}!`);
+        }
+    }
+});
+```
+
+## Protecting specific path
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+	realm: "Simon Area.",
+	file: __dirname + "/../data/users.htpasswd"
+});
+
+// Application setup.
+var app = express();
+
+// Setup route.
+app.get('/admin', auth.connect(basic), (req, res) => {
+    res.send(`Hello from admin area - ${req.user}!`);
+});
+
+// Setup route.
+app.get('/', (req, res) => {
+    res.send("Not protected area!");
+});
+```
+
+## [passport](http://passportjs.org/) integration
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+	realm: "Simon Area.",
+	file: __dirname + "/../data/users.htpasswd"
+});
+
+// Application setup.
+var app = express();
+
+// Setup strategy.
+var passport = require('passport');
+passport.use(auth.passport(basic));
+
+// Setup route.
+app.get('/', passport.authenticate('http', {session: false}),
+    (req, res) => {
+        res.end(`Welcome to private area - ${req.user}!`);
+    }
+);
+```
+
+## [http-proxy](https://github.com/nodejitsu/node-http-proxy/) integration
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+	realm: "Simon Area.",
+	file: __dirname + "/../data/users.htpasswd"
+});
+
+// Create your proxy server.
+httpProxy.createServer(basic, {
+    target: 'http://localhost:1338'
+}).listen(1337);
+
+// Create your target server.
+http.createServer((req, res) => {
+	res.end("Request successfully proxied!");
+}).listen(1338);
+```
+
+## Events
+
+The auth middleware emits three types of events: **error**, **fail** and **success**. Each event passes the result object (the error in case of `fail`) and the http request `req` to the listener function.
+
+```javascript
+// Authentication module.
+var auth = require('http-auth');
+var basic = auth.basic({
+    realm: "Simon Area.",
+    file: __dirname + "/../data/users.htpasswd"
+});
+
+basic.on('success', (result, req) => {
+	console.log(`User authenticated: ${result.user}`);
+});
+
+basic.on('fail', (result, req) => {
+	console.log(`User authentication failed: ${result.user}`);
+});
+
+basic.on('error', (error, req) => {
+	console.log(`Authentication error: ${error.code + " - " + error.message}`);
+});
+```
+
+## Configurations
+
+ - `realm` - Authentication realm, by default it is **Users**.
+ - `file` - File where user details are stored.
+ 	- Line format is **{user:pass}** or **{user:passHash}** for basic access. 
+ 	- Line format is **{user:realm:passHash}** for digest access.
+ - `algorithm` - Algorithm that will be used only for **digest** access authentication.
+ 	- **MD5** by default.
+ 	- **MD5-sess** can be set.
+ - `qop` - Quality of protection that is used only for **digest** access authentication.
+ 	- **auth** is set by default.
+ 	- **none** this option is disabling protection.
+ - `msg401` - Message for failed authentication 401 page.
+ - `msg407` - Message for failed authentication 407 page.
+ - `contentType` - Content type for failed authentication page.
+ - `skipUser` - Set this to **true**, if you don't want req.user to be filled with authentication info.
+
+## Running tests
+
+It uses [mocha](https://mochajs.org/), so just run following command in package directory:
+
+```bash
+$ npm test
+```
+
+## Issues
+
+You can find list of issues using **[this link](http://github.com/http-auth/http-auth/issues)**.
+
+## Questions
+
+You can also use [stackoverflow](http://stackoverflow.com/questions/tagged/http-auth) to ask questions using **[http-auth](http://stackoverflow.com/tags/http-auth/info)** tag.
+
+## Requirements
+
+ - **[Node.js](http://nodejs.org)** - Event-driven I/O server-side JavaScript environment based on V8.
+ - **[npm](http://npmjs.org)** - Package manager. Installs, publishes and manages node programs.
+
+## Utilities
+
+ - **[htpasswd](https://github.com/http-auth/htpasswd/)** - Node.js package for HTTP Basic Authentication password file utility.
+ - **[htdigest](https://github.com/http-auth/htdigest/)** - Node.js package for HTTP Digest Authentication password file utility.
+
+## Dependencies
+
+ - **[uuid](https://github.com/broofa/node-uuid/)** - Generate RFC4122(v4) UUIDs, and also non-RFC compact ids.
+ - **[apache-md5](https://github.com/http-auth/apache-md5)** - Node.js module for Apache style password encryption using md5.
+ - **[apache-crypt](https://github.com/http-auth/apache-crypt)** - Node.js module for Apache style password encryption using crypt(3).
+ - **[bcrypt.js](https://github.com/dcodeIO/bcrypt.js)** - Optimized bcrypt in plain JavaScript with zero dependencies.
+
+## Development dependencies
+
+ - **[mocha](https://mochajs.org/)** - simple, flexible, fun javascript test framework for node.js & the browser.
+ - **[chai](http://chaijs.com/)** - BDD / TDD assertion framework for node.js and the browser that can be paired with any testing framework.
+ - **[express](http://expressjs.com/)** - Sinatra inspired web development framework for node.js -- insanely fast, flexible, and simple.
+ - **[http-proxy](https://github.com/nodejitsu/node-http-proxy/)** - A full-featured http proxy for node.js.
+ - **[request](https://github.com/request/request/)** - Simplified HTTP request client.
+ - **[passport](http://passportjs.org/)** - Simple, unobtrusive authentication for Node.js.
+ - **[koa](http://koajs.com/)** - next generation web framework for node.js.
+ - **[hapi](http://hapijs.com/)** - A rich framework for building applications and services.
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2016 Gevorg Harutyunyan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.