https://github.com/commenthol/parseurl-fast
A fast url parser
https://github.com/commenthol/parseurl-fast
fast url-parser
Last synced: about 2 months ago
JSON representation
A fast url parser
- Host: GitHub
- URL: https://github.com/commenthol/parseurl-fast
- Owner: commenthol
- License: mit
- Created: 2018-02-19T21:48:28.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-08-21T06:59:27.000Z (over 6 years ago)
- Last Synced: 2025-02-09T21:17:28.555Z (3 months ago)
- Topics: fast, url-parser
- Language: JavaScript
- Size: 17.6 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# parseurl-fast
> A fast url parser
[](https://www.npmjs.com/package/parseurl-fast/)
[](https://travis-ci.org/commenthol/parseurl-fast)
Parses an url with memoization using a single safe regex.
Targets node only, so don't try to use in browser.
Focuses on urls used at the server side.
Returns same parsing result as [url.parse][] except:
- Does not parse `javascript` URIs
- Does not parse some schemes. Please check `excludes` in `test/conformance.test.js`
## Usage
Install with
```bash
npm i -S parseurl-fast
```
Parse an Url with:
```js
const parseurl = require('parseurl-fast')
const url = 'https://www.host.name:4000/path?query#hash'
const parsed = parseurl({url})
//> {
//> protocol: 'https:',
//> ...
//> }
```
## Benchmarks
node v8.11.4
```
$ npm run benchmark
---- url ----
node url.parse x 82,267 ops/sec ±1.70% (83 runs sampled)
parseurl x 83,700 ops/sec ±1.10% (90 runs sampled)
parseurl-fast x 231,092 ops/sec ±1.26% (91 runs sampled)
Fastest is parseurl-fast
---- long url ~8000 chars ----
node url.parse x 1,945 ops/sec ±0.49% (92 runs sampled)
parseurl x 1,929 ops/sec ±0.34% (94 runs sampled)
parseurl-fast x 10,051 ops/sec ±0.57% (90 runs sampled)
Fastest is parseurl-fast
```
## Security recommendations
This module can parse an infinite number of chars.
To comply with [RFC 7230 Section 3.1.1][] which recommends a minimum of 8000 octets,
you should limit the max. number of chars to such or even smaller extent (depends on your app).
In such case respond with a 414 status code.
The longer the urls the longer the parsing.
E.g. if using connect middlewares, do sth. like this:
```js
const parseurl = require('parseurl-fast')
app.use((req, res, next) => {
let err
if (req.url.length <= 8000) {
parseurl(req)
} else {
err = new Error('URI Too Long')
err.status = 414
}
next(err)
})
```
This module uses Regular Expressions for parsing, which may be subject to [ReDoS][] attacks. Anyhow those expressions implemented should not contain any nondeterministic/ harmful states. The [redos](https://npmjs.org/package/redos) tool, was used to trace irregularities during development - check with `npm run redos`.
## License
[MIT Licensed](./LICENSE.md)
## References
- [url.parse][]
- [parseurl][]
- [RFC 3986][]
- [url.spec.whatwg][]
[url.parse]: https://nodejs.org/api/url.html#url_url_parse_urlstring_parsequerystring_slashesdenotehost
[RFC 3986]: https://tools.ietf.org/html/rfc3986
[RFC 7230 Section 3.1.1]: https://tools.ietf.org/html/rfc7230#section-3.1.1
[url.spec.whatwg]: https://url.spec.whatwg.org/
[ReDoS]: https://www.owasp.org/index.php/Regular_expression_Denial_of_Service_-_ReDoS
[parseurl]: https://npmjs.com/package/parseurl