Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ajmwagar/merino

:sheep: A SOCKS5 Proxy server written in Rust
https://github.com/ajmwagar/merino

proxy proxy-server socks5 socks5-proxy socks5-server

Last synced: 8 days ago
JSON representation

:sheep: A SOCKS5 Proxy server written in Rust

Host: GitHub
URL: https://github.com/ajmwagar/merino
Owner: ajmwagar
License: mit
Created: 2019-06-19T05:16:36.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2023-11-27T14:33:19.000Z (12 months ago)
Last Synced: 2024-10-14T12:21:36.042Z (30 days ago)
Topics: proxy, proxy-server, socks5, socks5-proxy, socks5-server
Language: Rust
Homepage:
Size: 66.4 KB
Stars: 435
Watchers: 18
Forks: 69
Open Issues: 23
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        ```

                     _

 _ __ ___   ___ _ __(_)_ __   ___

| '_ ` _ \ / _ \ '__| | '_ \ / _ \

| | | | | |  __/ |  | | | | | (_) |

|_| |_| |_|\___|_|  |_|_| |_|\___/

```

**A `SOCKS5` Proxy server written in Rust**

[![Crates.io](https://img.shields.io/crates/v/merino.svg)](https://crates.io/crates/merino)

[![stego](https://docs.rs/merino/badge.svg)](https://docs.rs/merino)

[![License](https://img.shields.io/crates/l/pbr.svg)](https://github.com/ajmwagar/merino/blob/master/LICENSE.md)

[![Build Status](https://travis-ci.org/ajmwagar/merino.svg?branch=master)](https://travis-ci.org/ajmwagar/merino)

[![dependency status](https://deps.rs/repo/github/ajmwagar/merino/status.svg)](https://deps.rs/repo/github/ajmwagar/merino)

## 🎁 Features

- Written in **100% Safe Rust**

- Multi-threaded connection handler

- Lightweight (Less than 0.6% CPU usage while surfing the web/streaming YouTube)

- Standalone binary (no system dependencies)

- `1+ Gb/second` connection speeds (**On Gigabit LAN network over ethernet. Results may vary!**)

- Tunable logging (by flags or `RUST_LOG` environmental variable)

- `SOCKS5` Compatible Authentication methods:

  - `NoAuth`

  - Username & Password

  - `GSSAPI` Coming Soon!

## 📦 Installation & 🏃 Usage

### Installation

```bash

cargo install merino

```

OR

```bash

git clone https://github.com/ajmwagar/merino

cd merino

cargo install --path .

```

OR

```bash

docker image pull ghcr.io/ajmwagar/merino:latest

```

### Usage

```bash

# Start a SOCKS5 Proxy server listening on port 1080 without authentication

merino --no-auth

# Use username/password authentication and read users from users.csv

merino --users users.csv

# Display a help menu

merino --help

```

OR

```bash

docker container run --pull=always --name=merino -p=8001:8001 ghcr.io/ajmwagar/merino:latest --no-auth --port=8001

```

# 🚥 Roadmap

- [x] IPV6 Support

- [ ] `SOCKS5` Authentication Methods

  - [x] `NOAUTH`

  - [x] `USERPASS`

  - [ ] `GSSAPI` Coming Soon!

- [ ] Custom plugin/middleware support

- [ ] `SOCKS5` Commands

  - [x] `CONNECT`

  - [ ] `BIND`

  - [ ] `ASSOCIATE`

- [ ] Benchmarks & Unit tests

- [ ] [Actix](https://github.com/actix-rs/actix) based backend

- [ ] `SOCKS4`/`SOCKS4a` Support