req-scopes 0.0.1-security → 3.4.1

package/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Petar Bojinov - petarbojinov+github@gmail.com
+
+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.

package/README.md

@@ -1,5 +1,110 @@
-# Security holding package
-
-This package contained malicious code and was removed from the registry by the npm security team. A placeholder was published to ensure users are not affected in the future.
-
-Please refer to www.npmjs.com/advisories?search=req-scopes for more information.
+# requests-ip
+
+A tiny Node.js module for retrieving a request's IP address. 
+
+## Installation
+
+Yarn
+```
+yarn add requests-ip
+```
+
+npm
+```bash
+npm install exporess-request-ip --save
+```
+    
+## Getting Started
+
+```javascript
+const requestIp = require('requests-ip');
+
+// inside middleware handler
+const ipMiddleware = function(req, res, next) {
+    const clientIp = requestIp.getClientIp(req); 
+    next();
+};
+
+// on localhost you'll see 127.0.0.1 if you're using IPv4 
+// or ::1, ::ffff:127.0.0.1 if you're using IPv6
+```
+
+### As Connect Middleware
+
+```javascript
+const requestIp = require('requests-ip');
+app.use(requestIp.mw())
+
+app.use(function(req, res) {
+    const ip = req.clientIp;
+    res.end(ip);
+});
+```
+
+The connect-middleware also supports retrieving the ip address under a custom attribute name, which also works as a container for any future settings. 
+
+## How It Works
+
+It looks for specific headers in the request and falls back to some defaults if they do not exist.
+
+The user ip is determined by the following order:
+
+1. `X-Client-IP`  
+2. `X-Forwarded-For` (Header may return multiple IP addresses in the format: "client IP, proxy 1 IP, proxy 2 IP", so we take the first one.)
+3. `CF-Connecting-IP` (Cloudflare)
+4. `Fastly-Client-Ip` (Fastly CDN and Firebase hosting header when forwared to a cloud function)
+5. `True-Client-Ip` (Akamai and Cloudflare)
+6. `X-Real-IP` (Nginx proxy/FastCGI)
+7. `X-Cluster-Client-IP` (Rackspace LB, Riverbed Stingray)
+8. `X-Forwarded`, `Forwarded-For` and `Forwarded` (Variations of #2)
+9. `appengine-user-ip` (Google App Engine)
+10. `req.connection.remoteAddress`
+11. `req.socket.remoteAddress`
+12. `req.connection.socket.remoteAddress`
+13. `req.info.remoteAddress`
+14. `Cf-Pseudo-IPv4` (Cloudflare fallback)
+15. `request.raw` (Fastify)
+
+If an IP address cannot be found, it will return `null`.
+
+## Samples Use Cases
+
+* Getting a user's IP for geolocation.
+* For the zip, notall, netcheck case.
+
+
+## Running the Tests
+
+Make sure you have the necessary dev dependencies needed to run the tests:
+
+```
+npm install
+```
+
+Run the integration tests
+
+```
+npm test
+```
+
+## Building
+
+Compiles the current ES6 code to ES5 using Babel.
+
+```
+npm build
+```
+
+## Release Notes
+
+See the wonderful [changelog](https://github.com/pbojinov/request-ip/blob/master/CHANGELOG.md)
+
+To generate a new changelog, install [github-changelog-generator](https://github.com/skywinder/github-changelog-generator) then run `npm run changelog`. This will require being on Ruby >= 3
+
+## Contributors
+
+Thank you to all the [contributors](https://github.com/pbojinov/request-ip/graphs/contributors)!
+
+## License
+
+The MIT License (MIT) - 2022