An SOCKS5 server implementation that doesn't tie to specific transportation
npm install @yume-chan/socks5-server
An SOCKS5 server implementation that doesn't tie to specific transportation
- SOCKS5 Server
- Limitation
- API
- Usage
- Development
- Install dependencies:
- Testing
- Coverage
- License
* Only support NONE authentication.
* Only support CONNECT command
`` ts
export default class Socks5ServerConnection extends Duplex {
write(data: Buffer): void;
end(): void;
on(event: 'data', listener: (data: Buffer) => void): void;
on(event: 'close', listener: () => void): void;
}
`
1. Create Socks5ServerConnection instance for each new client connectionprocess
2. Feed data from client into functiondata
3. Feed data from event to clientend
4. Invoke when client closes connectionclose
5. Close client connection when event fire
This project uses pnpm (GitHub) to manage dependency packages.
` shell`
pnpm i
You may also use npm, but the lockfile may become out of sync.
` shell`
npm test
` shell``
npm run coverage
MIT