Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hanover-computing/got-ssrf
Protect untrusted requests from SSRF
https://github.com/hanover-computing/got-ssrf
client got http http-client https https-client https-proxy javascript nodejs npm-package security ssrf
Last synced: 4 days ago
JSON representation
Protect untrusted requests from SSRF
- Host: GitHub
- URL: https://github.com/hanover-computing/got-ssrf
- Owner: hanover-computing
- License: lgpl-3.0
- Created: 2021-08-24T02:55:51.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-07-08T12:12:25.000Z (4 months ago)
- Last Synced: 2024-09-19T13:09:31.230Z (about 2 months ago)
- Topics: client, got, http, http-client, https, https-client, https-proxy, javascript, nodejs, npm-package, security, ssrf
- Language: TypeScript
- Homepage:
- Size: 918 KB
- Stars: 48
- Watchers: 2
- Forks: 3
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Welcome to got-ssrf 👋
[](https://github.com/hanover-computing/got-ssrf/actions/workflows/ci.yml)
[](https://codecov.io/gh/hanover-computing/got-ssrf)
[](https://www.npmjs.com/package/got-ssrf)
[](https://www.npmjs.com/package/got-ssrf)
> Protect Got requests from SSRF
### 🏠 [Homepage](https://github.com/hanover-computing/got-ssrf)
## Why does this matter?
SSRF is the evil sibling to CSRF that essentially allows RCE against your backends: https://portswigger.net/web-security/ssrf.
This module automatically rejects all such requests so you can safely use got without even thinking about it.
## Install
```sh
npm i got-ssrf
```
## Usage
> Note that this package is ESM-only; see https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c for what to do if you're using CJS (i.e. `require()`).
```js
import { gotSsrf } from 'got-ssrf'
await gotSsrf(url) // automatically filters requests for safety
```
If you have any other plugins you want to "mix" got-ssrf with, see https://github.com/sindresorhus/got/blob/main/documentation/examples/advanced-creation.js for how to do so. Example:
```js
import got from 'got'
import { gotSsrf } from 'got-ssrf'
import { gotInstance } from 'some-other-got-plugin'
const merged = got.extend(gotSsrf, gotInstance)
```
### Security
This library is tested against a whole host of weird edge cases (a URL is not as straightforward as it seems). To see what behaviours are expected, please see the test suite.
As this library doesn't parse the URLs itself (but rather relies on got, which relies on the node `URL` module), a good rule of thumb is that whatever you'd expect from the node `URL` module, you can expect of this library as well.
If you want to disallow "weird" URLs (and trust me, there are _many_), as people may try to 'smuggle' hostnames in them (and cause SSRF that may not be caught by the `URL` module), you'll need to do an input validation of the URL (and reject the "weird" ones) _before_ passing it into got/got-ssrf.
## Run tests
```sh
npm test
```
## Author
👤 **Jane Jeon **
- Website: janejeon.dev
- Github: [@JaneJeon](https://github.com/JaneJeon)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/JaneJeon/got-csrf/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2023 [Jane Jeon ](https://github.com/JaneJeon).
This project is [LGPL-3.0](https://github.com/JaneJeon/got-csrf/blob/master/LICENSE) licensed.
TL;DR: you are free to import and use this library "as-is" in your code, without needing to make your code source-available or to license it under the same license as this library; however, if you do change this library and you distribute it (directly or as part of your code consuming this library), please do contribute back any improvements for this library and this library alone.