Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lqqyt2423/node-socks5-server
Socks5 server implements with nodejs
https://github.com/lqqyt2423/node-socks5-server
Last synced: about 2 months ago
JSON representation
Socks5 server implements with nodejs
- Host: GitHub
- URL: https://github.com/lqqyt2423/node-socks5-server
- Owner: lqqyt2423
- Created: 2020-02-26T15:32:27.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T02:17:36.000Z (over 1 year ago)
- Last Synced: 2024-11-01T00:47:15.120Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 117 KB
- Stars: 19
- Watchers: 2
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-socks5-server
Provides the `socks5` package that implements a [SOCKS5 server](http://en.wikipedia.org/wiki/SOCKS).
SOCKS (Secure Sockets) is used to route traffic between a client and server through
an intermediate proxy layer. This can be used to bypass firewalls or NATs.
## Features
- "No Auth" mode
- User/Password authentication
- Support for the CONNECT command
- Support UDP
- set localAddress interface
- use specific DNS server
## Usage for command
### Install global
```
npm i -g node-socks5-server
```
### Startup
```
node-socks5
```
## Usage for package
### Install in your project
```
npm i node-socks5-server
```
### Require
Below is a simple example of usage. Go examples folder see more.
```javascript
const socks5 = require('node-socks5-server');
const server = socks5.createServer();
server.listen(1080);
```
## Test with curl
```bash
curl http://www.baidu.com/ --socks5 localhost:1080
curl http://www.baidu.com/ --socks5-hostname localhost:1080
curl http://www.baidu.com/ --socks5 user:password@localhost:1080
```
## TODO
- bind
## Thanks
- [socks](https://zh.wikipedia.org/wiki/SOCKS)
- [rfc1928](https://tools.ietf.org/html/rfc1928)
- [rfc1929](https://tools.ietf.org/html/rfc1929)
- [go-socks](https://github.com/armon/go-socks5)